Skip to content

Commit

Permalink
feat: add info about apiKeys in config (#825)
Browse files Browse the repository at this point in the history
  • Loading branch information
stepan662 authored Jan 20, 2025
1 parent 824918a commit 9830228
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions tolgee-cli/project-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ By default, Tolgee uses its own internal extractor which looks for use of the [T

String. URL to the Tolgee instance you're using. If you're using Tolgee Cloud, you can ignore this.

### `apiKey`

String. Api key to tolgee platform. It can be a [Personal Access Token or a Project API Key](/platform/account_settings/api_keys_and_pat_tokens).

:::danger Make sure you don't leak your API key
Use `apiKey` only if you are loading it from an environment or other secured source (supported in .js or .yml files) or your config is not public.

In most cases, it's better to use a one-time [login command](#logging-in) or set it via the `TOLGEE_API_KEY` environment variable.
:::


### `format`

Format for push and pull operations. Check [supported formats](/platform/supported_formats).
Expand Down

0 comments on commit 9830228

Please sign in to comment.