Skip to content

Commit 2ad7731

Browse files
committed
Updated documentation, changed binary name
1 parent 458b47c commit 2ad7731

File tree

2 files changed

+41
-41
lines changed

2 files changed

+41
-41
lines changed

main.go

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,40 @@ import (
1616
"github.com/reconquest/hierr-go"
1717
)
1818

19-
var version = "1.0"
19+
var version = "1.1"
2020

21-
var usage = `smartling - manage translation files using Smartling.
21+
var usage = `smartling-cli - manage translation files using Smartling.
2222
2323
Add --help option to command to get detailed help for specific command.
2424
2525
Usage:
26-
smartling [options] [-v]... init --help
27-
smartling [options] [-v]... init [--dry-run]
28-
smartling [options] [-v]... projects list --help
29-
smartling [options] [-v]... projects list [--short]
30-
smartling [options] [-v]... projects info --help
31-
smartling [options] [-v]... projects info
32-
smartling [options] [-v]... projects locales --help
33-
smartling [options] [-v]... projects locales [--source] [--short] [--format=]
34-
smartling [options] [-v]... files list --help
35-
smartling [options] [-v]... files list [--format=] [--short] [<uri>]
36-
smartling [options] [-v]... files (pull|get) --help
37-
smartling [options] [-v]... files (pull|get) [--locale=]... [--directory=] [--source] [--format=]
26+
smartling-cli [options] [-v]... init --help
27+
smartling-cli [options] [-v]... init [--dry-run]
28+
smartling-cli [options] [-v]... projects list --help
29+
smartling-cli [options] [-v]... projects list [--short]
30+
smartling-cli [options] [-v]... projects info --help
31+
smartling-cli [options] [-v]... projects info
32+
smartling-cli [options] [-v]... projects locales --help
33+
smartling-cli [options] [-v]... projects locales [--source] [--short] [--format=]
34+
smartling-cli [options] [-v]... files list --help
35+
smartling-cli [options] [-v]... files list [--format=] [--short] [<uri>]
36+
smartling-cli [options] [-v]... files (pull|get) --help
37+
smartling-cli [options] [-v]... files (pull|get) [--locale=]... [--directory=] [--source] [--format=]
3838
[--progress=] [--retrieve=] [<uri>]
39-
smartling [options] [-v]... files push --help
40-
smartling [options] [-v]... files push [(--authorize|--locale=...)] [--branch=] [--type=]
39+
smartling-cli [options] [-v]... files push --help
40+
smartling-cli [options] [-v]... files push [(--authorize|--locale=...)] [--branch=] [--type=]
4141
[--directory=] [--directive=]... [<file>] [<uri>]
42-
smartling [options] [-v]... files rename --help
43-
smartling [options] [-v]... files rename <old-uri> <new-uri>
44-
smartling [options] [-v]... files status --help
45-
smartling [options] [-v]... files status [--directory=] [--format=] [<uri>]
46-
smartling [options] [-v]... files delete --help
47-
smartling [options] [-v]... files delete <uri>
48-
smartling [options] [-v]... files import --help
49-
smartling [options] [-v]... files import <uri> <file> <locale>
42+
smartling-cli [options] [-v]... files rename --help
43+
smartling-cli [options] [-v]... files rename <old-uri> <new-uri>
44+
smartling-cli [options] [-v]... files status --help
45+
smartling-cli [options] [-v]... files status [--directory=] [--format=] [<uri>]
46+
smartling-cli [options] [-v]... files delete --help
47+
smartling-cli [options] [-v]... files delete <uri>
48+
smartling-cli [options] [-v]... files import --help
49+
smartling-cli [options] [-v]... files import <uri> <file> <locale>
5050
[(--published|--post-translation)]
5151
[--type=] [--overwrite]
52-
smartling --help
52+
smartling-cli --help
5353
5454
Commands:
5555
init Prepares project to work with Smartling,

show_help.go

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ const globPatternHelp = `argument support globbing with following patterns:
3535
> [!xyz] — matches not 'x', 'y' or 'z' charachers;
3636
> {a,b,c} — matches alternatives a, b or c;`
3737

38-
const initHelp = `smartling init — create config file interactively.
38+
const initHelp = `smartling-cli init — create config file interactively.
3939
4040
Walk down common config file parameters and fill them through dialog.
4141
@@ -46,17 +46,17 @@ is lost.
4646
Options like --user, --secret, --account and --project can be used to specify
4747
config values prior dialog:
4848
49-
smartling init --user=your_user_id
49+
smartling-cli init --user=your_user_id
5050
5151
Also, --dry-run option can be used to just look at resulting config without
5252
overwritting anything:
5353
54-
smartling init --dry-run
54+
smartling-cli init --dry-run
5555
5656
By default, smartling.yml file in the local directory will be used as target
5757
config file, but it can be overriden by using --config option:
5858
59-
smartling init --config=/path/to/project/smartling.yml
59+
smartling-cli init --config=/path/to/project/smartling.yml
6060
6161
6262
Available options:
@@ -72,7 +72,7 @@ Default config values can be passed via following options:` +
7272
Specify default project.
7373
`
7474

75-
const projectsListHelp = `smartling projects list — list projects from account.
75+
const projectsListHelp = `smartling-cli projects list — list projects from account.
7676
7777
Command will list projects from specified account in tabular format with
7878
following information:
@@ -92,7 +92,7 @@ Available options:
9292
List only project IDs.
9393
` + authenticationOptionsHelp
9494

95-
const projectsInfoHelp = `smartling projects info — show detailed project info.
95+
const projectsInfoHelp = `smartling-cli projects info — show detailed project info.
9696
9797
Displays detailed information for specific project.
9898
@@ -101,7 +101,7 @@ Project should be specified either in config or via --project option.
101101
102102
Available options:` + authenticationOptionsHelp
103103

104-
const projectsLocalesHelp = `smartling projects locales — list target locales.
104+
const projectsLocalesHelp = `smartling-cli projects locales — list target locales.
105105
106106
Lists target locales from specified project.
107107
@@ -125,7 +125,7 @@ Available options:
125125
Use specific output format instead of default.
126126
` + authenticationOptionsHelp
127127

128-
const filesListHelp = `smartling files list — list files from project.
128+
const filesListHelp = `smartling-cli files list — list files from project.
129129
130130
Lists all files from project or only files which matches specified uri.
131131
@@ -160,7 +160,7 @@ Available options:
160160
Override default listing format.
161161
` + authenticationOptionsHelp
162162

163-
const filesPullHelp = `smartling files pull — downloads translated files from project.
163+
const filesPullHelp = `smartling-cli files pull — downloads translated files from project.
164164
165165
Downloads files from specified project into local directory.
166166
@@ -171,7 +171,7 @@ specific locales only.
171171
If special value of "-" is specified as <uri>, then program will expect
172172
to read files list from stdin:
173173
174-
cat files.txt | smartling files pull -
174+
cat files.txt | smartling-cli files pull -
175175
176176
<uri> ` + globPatternHelp + `
177177
@@ -219,7 +219,7 @@ Available options:
219219
> contextMatchingInstrumented — to use with Chrome Context Capture;
220220
` + authenticationOptionsHelp
221221

222-
const filesPushHelp = `smartling files push <file> [<uri>] [--type <type>] [--branch (@auto|<branch name>)] [--authorize|--locale <locale>] [--directory <work dir>] [--directive <smartling directive>]
222+
const filesPushHelp = `smartling-cli files push <file> [<uri>] [--type <type>] [--branch (@auto|<branch name>)] [--authorize|--locale <locale>] [--directory <work dir>] [--directive <smartling directive>]
223223
224224
Uploads files designated for translation.
225225
@@ -263,7 +263,7 @@ Available options:
263263
Override automatically detected file type.
264264
` + authenticationOptionsHelp
265265

266-
const filesStatusHelp = `smartling files status — show files status from project.
266+
const filesStatusHelp = `smartling-cli files status — show files status from project.
267267
268268
Lists all files from project along with their translation progress into
269269
different locales.
@@ -305,7 +305,7 @@ Available options:
305305
Specify format for listing file names.
306306
` + authenticationOptionsHelp
307307

308-
const filesDeleteHelp = `smartling files delete — removes files from project.
308+
const filesDeleteHelp = `smartling-cli files delete — removes files from project.
309309
310310
Removes files from project according to specified pattern.
311311
@@ -314,14 +314,14 @@ Removes files from project according to specified pattern.
314314
If special value of "-" is specified as <uri>, then program will expect
315315
to read files list from stdin:
316316
317-
cat files.txt | smartling files delete -
317+
cat files.txt | smartling-cli files delete -
318318
319319
Available options:
320320
-p --project <project>
321321
Specify project to use.
322322
` + authenticationOptionsHelp
323323

324-
const filesRenameHelp = `smartling files rename — rename specified file.
324+
const filesRenameHelp = `smartling-cli files rename — rename specified file.
325325
326326
Renames specified file URI into new file URI.
327327
@@ -330,7 +330,7 @@ Available options:
330330
Specify project to use.
331331
` + authenticationOptionsHelp
332332

333-
const importHelp = `smartling import — import file translations.
333+
const importHelp = `smartling-cli import — import file translations.
334334
335335
Import pre-existent file translations into Smartling. Note, that
336336
original file should be pushed prior file translations are imported.

0 commit comments

Comments
 (0)