Skip to content

Commit 3b97e39

Browse files
authored
Update README.md
1 parent db885b1 commit 3b97e39

File tree

1 file changed

+52
-40
lines changed

1 file changed

+52
-40
lines changed

README.md

Lines changed: 52 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ The installation process is automated by command-line scripts. Both scripts for
2121

2222
```shell
2323
# macOs / Linux / Windows (WSL)
24-
curl -s https://get.simplelocalize.io/2.5/install | bash
24+
curl -s https://get.simplelocalize.io/2.4/install | bash
2525

2626
# Windows (PowerShell)
27-
. { iwr -useb https://get.simplelocalize.io/2.5/install-windows } | iex;
27+
. { iwr -useb https://get.simplelocalize.io/2.4/install-windows } | iex;
2828
```
2929
3030
To change or update the CLI version, run the installation script with the desired version number in the URL, e.g.:
@@ -51,6 +51,7 @@ Available commands:
5151
- `auto-translate` - starts [auto-translation](https://simplelocalize.io/auto-translation) jobs
5252
- `pull` - downloads translation files from [Translation Hosting](https://simplelocalize.io/translation-hosting)
5353
- `publish` - publishes translations to [Translation Hosting](https://simplelocalize.io/translation-hosting)
54+
- `purge` - removes all translation, translation keys and languages from [Translation Editor](https://simplelocalize.io/translation-editor)
5455
- `extract` - finds and extracts translation keys in your project files
5556
5657
@@ -83,9 +84,8 @@ e.g.: `./src/translations/{lang}/{ns}.json`.
8384
8485
Upload format is a format of the file(s) with translations. [See available upload formats](https://simplelocalize.io/docs/general/file-formats/)
8586
86-
#### Additional parameters:
87+
**Additional parameters:**
8788
- `--replace` allows you to **replace** existing translations with new ones.
88-
- `--delete` allows you to **delete** translations that are not present in uploaded files.
8989
- `--dryRun` allows you to **check** what translation files will be uploaded without actually uploading them.
9090
- `--uploadOptions` allows you to pass [additional options](https://simplelocalize.io/docs/general/options/) to the upload command.
9191
Eg.: `--uploadOptions TRIM_LEADING_TRAILING_SPACES`. To pass multiple options, use comma as a separator.
@@ -108,53 +108,23 @@ e.g.: `./src/translations/{lang}/{ns}.json`.
108108
109109
Download format is a format of the file(s) with translations. [See available download formats](https://simplelocalize.io/docs/general/file-formats/)
110110
111-
#### Additional parameters:
111+
**Additional parameters:**
112112
- `--downloadOptions` allows you to pass [additional options](https://simplelocalize.io/docs/general/options/) to the download command. Eg.: `--downloadOptions WRITE_NESTED`.
113+
- `--downloadSort` allows you to sort translations in the downloaded file. Eg.: `--downloadSort NEWEST_KEYS_FIRST`. Available options: `NEWEST_KEYS_FIRST`, `NEWEST_KEYS_LAST`, `NAMESPACES`, `IMPORT_ORDER`.
113114
114115
Learn more about [download translations command](https://simplelocalize.io/docs/cli/download-translations/).
115116
116-
## Sync translations
117-
118-
Sync command combines upload and download command executions.
119-
120-
```properties
121-
simplelocalize sync
122-
--apiKey <PROJECT_API_KEY>
123-
--downloadPath <DOWNLOAD_PATH>
124-
--downloadFormat <DOWNLOAD_FORMAT>
125-
--downloadOptions <DOWNLOAD_OPTIONS>
126-
--uploadPath <UPLOAD_PATH>
127-
--uploadFormat <UPLOAD_FORMAT>
128-
--uploadOptions <UPLOAD_OPTIONS>
129-
```
130-
131-
`--downloadOptions` and `--uploadOptions` parameters are optional.
132-
133-
## Auto-translate translations
117+
## Auto-translate strings
134118
135119
Auto-translate command starts [auto-translation](https://simplelocalize.io/auto-translation) jobs.
136120
137121
```properties
138122
simplelocalize auto-translate --apiKey <PROJECT_API_KEY>
139123
```
140124
141-
Additional parameters:
125+
**Additional parameters:**
142126
- `--languageKeys` allows you to specify languages to auto-translate. Eg.: `--languageKeys en,de,fr`.
143127
144-
## Extract translation keys
145-
146-
Extract command finds and upload translation keys from project source code at `<SEARCH_DIRECTORY>` to SimpleLocalize.
147-
148-
```properties
149-
simplelocalize extract
150-
--apiKey <PROJECT_API_KEY>
151-
--searchDir <SEARCH_DIRECTOR>
152-
--projectType <PROJECT_TYPE>
153-
```
154-
155-
See [available project types](https://simplelocalize.io/docs/cli/i18n-keys-extraction/).
156-
157-
158128
## Usage examples
159129
160130
Below, you can find some examples of using SimpleLocalize CLI.
@@ -252,15 +222,57 @@ If you would like to filter files which should be downloaded you can use `--filt
252222
e.g.: `--filterRegex '__index.json'` will download only `__index.json` file.
253223
254224
255-
256-
## Getting project details
225+
## Get project details
257226
258227
Command gets project details and prints them to the console.
259228
260229
```properties
261230
simplelocalize status --apiKey <PROJECT_API_KEY>
262231
```
263232
233+
## Sync translations
234+
235+
Sync command combines upload and download command executions.
236+
237+
```properties
238+
simplelocalize sync
239+
--apiKey <PROJECT_API_KEY>
240+
--downloadPath <DOWNLOAD_PATH>
241+
--downloadFormat <DOWNLOAD_FORMAT>
242+
--downloadOptions <DOWNLOAD_OPTIONS>
243+
--uploadPath <UPLOAD_PATH>
244+
--uploadFormat <UPLOAD_FORMAT>
245+
--uploadOptions <UPLOAD_OPTIONS>
246+
```
247+
248+
`--downloadOptions` and `--uploadOptions` parameters are optional.
249+
250+
251+
## Purge translations
252+
253+
Command removes all translations, translation keys and languages from [Translation Editor](https://simplelocalize.io/translation-editor).
254+
255+
```properties
256+
simplelocalize purge --apiKey <PROJECT_API_KEY>
257+
```
258+
259+
**Additional parameters:**
260+
- `--force` allows you to skip confirmation prompt.
261+
262+
## Extract translation keys
263+
264+
Extract command finds and upload translation keys from project source code at `<SEARCH_DIRECTORY>` to SimpleLocalize.
265+
266+
```properties
267+
simplelocalize extract
268+
--apiKey <PROJECT_API_KEY>
269+
--searchDir <SEARCH_DIRECTOR>
270+
--projectType <PROJECT_TYPE>
271+
```
272+
273+
See [available project types](https://simplelocalize.io/docs/cli/i18n-keys-extraction/).
274+
275+
264276
265277
## Configuration file
266278
Use configuration file in order to simplify your bash command.

0 commit comments

Comments
 (0)