You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-48Lines changed: 30 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,17 +11,16 @@
11
11
SimpleLocalize CLI is a command-line tool that allows you to manage translations in your software project,
12
12
and it's a great tool for CI/CD pipelines and localization automation.
13
13
14
-
-**Upload and download translations.** The main purpose of the command-line tool is to upload and download translation files from [Translation Editor](https://simplelocalize.io/translation-editor/) to your project.
15
-
-**[Auto-translate](https://simplelocalize.io/auto-translation/) strings.** Start auto-translation jobs from the command-line and get translated strings in a few minutes.
16
-
-**[Host translations](https://simplelocalize.io/translation-hosting/).** Push and pull translations from Translation Hosting to your project using the command-line.
17
-
-**[GitHub Actions support](https://github.com/simplelocalize/github-action-cli/).** Use SimpleLocalize CLI in your GitHub Actions workflows.
18
-
-**Check project status.** Get project details from the command-line and check if your translations are up-to-date.
14
+
-[Synchronize files](https://simplelocalize.io/auto-translation/) - keep in sync all your translation files
15
+
-[Auto-translate](https://simplelocalize.io/auto-translation/) - auto-translate texts in seconds
16
+
-[Host translations](https://simplelocalize.io/translation-hosting/) - manage your hosted translations
17
+
-[GitHub Actions support](https://github.com/simplelocalize/github-action-cli/) - use SimpleLocalize CLI in your GitHub Actions workflows
19
18
20
19
## Installation
21
20
22
21
The installation process is automated by command-line scripts. Both scripts for Windows (PowerShell) and macOS/Linux/Windows downloads a binary file with CLI, copies it to user files and makes it available to run anywhere in the system from a command-line.
@@ -41,28 +40,17 @@ See [releases](https://github.com/simplelocalize/simplelocalize-cli/releases) fo
41
40
## Usage
42
41
43
42
The command-line tool offers several commands to execute. All of them requires Project API Key that is unique for each project.
44
-
You can set`apiKey`in simplelocalize.yml configuration file, pass it as parameter with `--apiKey` orset it by environment variable `SIMPLELOCALIZE_API_KEY`.
43
+
You can set`apiKey`via [configuration file](/simplelocalize-cli/wiki/Configuration-file), pass it as parameter with `--apiKey` or by environment variable `SIMPLELOCALIZE_API_KEY`.
45
44
46
-
```shell
45
+
```bash
47
46
simplelocalize [command] ...parameters
48
47
```
49
48
50
-
Available commands:
51
-
- `init` - creates a sample configuration file
52
-
- `status` - gets translation project details
53
-
- `upload` - uploads translation files or translation keys
54
-
- `download` - downloads translation files
55
-
- `auto-translate` - auto-translates texts in the editor
56
-
- `pull` - downloads translation files from translation hosting
57
-
- `publish` - publishes translations to hosting environment
58
-
- `purge` - removes all translation, translation keys and languages from the project
59
-
- `extract` - finds and extracts translation keys in your project files
60
-
61
49
## Upload translations
62
50
63
51
Upload command takes your local files and uploads them to SimpleLocalize.
64
52
65
-
```shell
53
+
```bash
66
54
simplelocalize upload
67
55
--apiKey PROJECT_API_KEY
68
56
--uploadPath INPUT_FILE
@@ -73,9 +61,9 @@ simplelocalize upload
73
61
74
62
## Download translations
75
63
76
-
Download command takes translation from SimpleLocalize and saves them to your local files.
64
+
Download command takes translations from SimpleLocalize and saves them to your local files.
77
65
78
-
```shell
66
+
```bash
79
67
simplelocalize download
80
68
--apiKey PROJECT_API_KEY
81
69
--downloadPath DOWNLOAD_PATH
@@ -86,12 +74,10 @@ simplelocalize download
86
74
87
75
## Auto-translate strings
88
76
89
-
Auto-translate command starts auto-translation tasks forall languagesin the project or forlanguages specifiedin`--languageKeys` parameter.
77
+
Auto-translate command starts auto-translation tasks forproject languages and waits forthe finish.
Please refer to the [official SimpleLocalize documentation](https://simplelocalize.io/docs/cli/get-started/). That should help you troubleshoot common issues. For additional help, you can reach out to us on one of these channels:
0 commit comments