mirego/accent
1
1
Fork 0
mirror of https://github.com/mirego/accent.git synced 2024-09-11 10:55:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update CLI README.md (#364)

Browse Source 
Added:
Documentation to undocumented:
- `accent.json` variable `project`
- ENV Variables to override config file variables
This commit is contained in:
Guillaume Chx 2023-08-25 16:15:48 +02:00 committed by GitHub
parent de77b05258
commit d6736229a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
cli/README.md
View File

@ -53,6 +53,18 @@ accent-cli reads from a `accent.json` file. The file should contain valid JSON r
## Document configuration
Format for the `accent.json` file.
- `apiUrl`: The base URL of your Accent Instance
- `apiKey`: Api Key to your Accent Instance
- `project`: Your Project uuid
Available ENV variables. (Each variable will override `accent.json` variables if set)
- `ACCENT_API_KEY`: The base URL of your Accent Instance
- `ACCENT_API_URL`: Api Key to your Accent Instance
- `ACCENT_PROJECT`: Your Project uuid
Each operation section `sync` and `addTranslations` can contain the following object:
- `language`: The identifier of the document’s language