Skip to content

Commit f59eaba

Browse files
Update README.md
1 parent c792703 commit f59eaba

File tree

1 file changed

+30
-48
lines changed

1 file changed

+30
-48
lines changed

README.md

Lines changed: 30 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,16 @@
1111
SimpleLocalize CLI is a command-line tool that allows you to manage translations in your software project,
1212
and it's a great tool for CI/CD pipelines and localization automation.
1313

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
1918

2019
## Installation
2120

2221
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.
2322

24-
```shell
23+
```bash
2524
# macOs / Linux / Windows (WSL)
2625
curl -s https://get.simplelocalize.io/2.8/install | bash
2726

@@ -41,28 +40,17 @@ See [releases](https://github.com/simplelocalize/simplelocalize-cli/releases) fo
4140
## Usage
4241
4342
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` or set 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`.
4544
46-
```shell
45+
```bash
4746
simplelocalize [command] ...parameters
4847
```
4948
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-
6149
## Upload translations
6250
6351
Upload command takes your local files and uploads them to SimpleLocalize.
6452
65-
```shell
53+
```bash
6654
simplelocalize upload
6755
--apiKey PROJECT_API_KEY
6856
--uploadPath INPUT_FILE
@@ -73,9 +61,9 @@ simplelocalize upload
7361
7462
## Download translations
7563
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.
7765
78-
```shell
66+
```bash
7967
simplelocalize download
8068
--apiKey PROJECT_API_KEY
8169
--downloadPath DOWNLOAD_PATH
@@ -86,12 +74,10 @@ simplelocalize download
8674
8775
## Auto-translate strings
8876
89-
Auto-translate command starts auto-translation tasks for all languages in the project or for languages specified in `--languageKeys` parameter.
77+
Auto-translate command starts auto-translation tasks for project languages and waits for the finish.
9078
91-
```properties
92-
simplelocalize auto-translate
93-
--apiKey PROJECT_API_KEY
94-
--languageKeys en,fr,de,pl
79+
```bash
80+
simplelocalize auto-translate --apiKey PROJECT_API_KEY
9581
```
9682
9783
[GitHub Wiki: Auto-translate strings](/simplelocalize/simplelocalize-cli/wiki/Auto%E2%80%90translate-strings)
@@ -104,7 +90,7 @@ There are two commands that operates on [translation hosting](https://simpleloca
10490
10591
Publish translations between translation editor and hosting or between hosting environments.
10692
107-
```
93+
```bash
10894
simplelocalize publish
10995
--apiKey PROJECT_API_KEY
11096
--environment _latest
@@ -116,8 +102,7 @@ simplelocalize publish
116102
117103
Pull command downloads files from translation hosting.
118104
119-
Pulls translations from the `_latest` environment.
120-
```properties
105+
```bash
121106
simplelocalize pull
122107
--apiKey PROJECT_API_KEY
123108
--pullPath ./hosting/
@@ -130,21 +115,23 @@ simplelocalize pull
130115
131116
### Initalize configuration file
132117
133-
Command creates a sample configuration file in the current directory.
118+
Command creates a sample [configuration file](/simplelocalize/simplelocalize-cli/wiki/Configuration-file) in the current directory.
134119
135-
```shell
120+
```bash
136121
simplelocalize init
137122
```
138123
124+
[GitHub Wiki: Additional commands](/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
125+
139126
### Get project details
140127
141-
Command gets project details and prints them to the console.
128+
Command gets project details and prints them.
142129
143130
```bash
144131
simplelocalize status --apiKey PROJECT_API_KEY
145132
```
146133
147-
[GitHub Wiki: Additional commands](https://github.com/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
134+
[GitHub Wiki: Additional commands](/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
148135
149136
### Purge translations
150137
@@ -154,32 +141,25 @@ Command removes all translations, translation keys and languages.
154141
simplelocalize purge --apiKey PROJECT_API_KEY
155142
```
156143
157-
[GitHub Wiki: Additional commands](https://github.com/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
144+
[GitHub Wiki: Additional commands](/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
158145
159146
### Extract translation keys
160147
161148
Extract command finds translation keys and translations from the source code.
162149
163150
```bash
164-
simplelocalize extract
165-
--searchDir SEARCH_DIRECTORY
166-
--projectType PROJECT_TYPE
151+
simplelocalize extract --searchDir SEARCH_DIRECTORY --projectType PROJECT_TYPE
167152
```
168153
169-
[GitHub Wiki: Additional commands](https://github.com/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
154+
[GitHub Wiki: Additional commands](/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
170155
171156
## Configuration file
172157
173-
Create configuration file to to simplify the bash commands.
174-
Arguments used in command always override properties set in the configuration file.
175-
By default, SimpleLocalize loads configuration from `simplelocalize.yml` file.
158+
Create configuration file to to simplify the bash commands. Arguments used in command always override properties set in the configuration file.
176159
177-
```properties
178-
# Load default simplelocalize.yml file
160+
```bash
161+
# It load simplelocalize.yml file by default
179162
simplelocalize upload
180-
181-
# Use configuration file at custom location
182-
simplelocalize -c my-configuration.yml upload
183163
```
184164
185165
[GitHub Wiki: Configuration file](/simplelocalize/simplelocalize-cli/wiki/Configuration-file)
@@ -191,12 +171,14 @@ variables.
191171
192172
Here are some examples of how to set proxy environment variables in Linux and macOS:
193173
194-
```shell
174+
```bash
195175
export http_proxy=http://someproxy.com
196176
export http_proxy=http://someproxy.com:8080
197177
export http_proxy=http://user:[email protected]:8080
198178
```
199179
180+
[GitHub Wiki: Proxy support](/simplelocalize/simplelocalize-cli/wiki/Proxy-Support)
181+
200182
## Support
201183
202184
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

Comments
 (0)