Skip to content

Commit c52d5ce

Browse files
committed
docs(cli): add replexica cli docs
1 parent 64aff94 commit c52d5ce

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

getting-started.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,26 @@ So, whatever approach you choose for switching between locales, just be sure to
218218
> [!WARNING]
219219
> Be sure to drop by our Discord (link at the bottom) if you have an opinion on how Replexica should be handling the locale detection. Even if your idea is exotic or feels unfeasible, we'd love to hear it! 🙏 (feel free to send in private, if you want).
220220
221+
## Replexica CLI
222+
223+
## `replexica auth`
224+
225+
* `replexica auth` - Check current authentication status.
226+
* `replexica auth --login` - (Re-)Authenticate with Replexica API.
227+
* `replexica auth --logout` - Log out from Replexica API.
228+
229+
## `replexica i18n`
230+
231+
* `replexica i18n` - Fetch translations from Replexica API, and save new translations to the cache.
232+
* `replexica i18n --cache-only` - Fetch translations from the cache only, and fails if some translations are missing. Useful for CI/CD workflows, when deterministic builds are required.
233+
* `replexica i18n --skip-cache` - Fetch translations from Replexica API, and rewrite the cache entirely. Useful when you want to force-fetch translations from the API.
234+
235+
## Recognized environment variables
236+
237+
Replexica CLI recognizes certain environment variables, either through the `.env` file or through the system environment variables:
238+
239+
* `REPLEXICA_API_KEY` - API key for Replexica API. Can be used in CI/CD workflows, as an alternative to the interactive login.
240+
221241
## Conclusion
222242

223243
That's it! You've successfully set up Replexica with Nextjs!

0 commit comments

Comments
 (0)