accent-cli

Accent CLI

• Usage
• Configuration
• Commands
• License
• About Mirego

Usage

$ npm install -g accent-cli
$ accent COMMAND
running command...
$ accent (-v|--version|version)
accent-cli/0.9.2 darwin-x64 node-v10.16.3
$ accent --help [COMMAND]
USAGE
  $ accent COMMAND
...

Configuration

accent-cli reads from a accent.json file. The file should contain valid JSON representing the configuration of your project.

Example

{
  "apiUrl": "http://your.accent.instance",
  "apiKey": "2nziVSaa8yUJxLkwoZA",
  "files": [
    {
      "format": "json",
      "source": "localization/fr/*.json",
      "target": "localization/%slug%/%document_path%.json",
      "hooks": {
        "afterSync": "touch sync-done.txt"
      }
    }
  ]
}

Document configuration

Each operation section sync and addTranslations can contain the following object:

• language: The identifier of the document’s language
• format: The format of the document
• source: The path of the document. This can contain glob pattern (See [the node glob library] used as a dependancy (https://github.com/isaacs/node-glob))
• target: Path of the target languages
• hooks: List of hooks to be run

Hooks

Here is a list of available hooks. Those are self-explanatory

• beforeSync
• afterSync
• beforeExport
• afterExport

Commands

• accent export
• accent help [COMMAND]
• accent jipt PSEUDOLANGUAGENAME
• accent stats
• accent sync

accent export

Export files from Accent and write them to your local filesystem

USAGE
  $ accent export

OPTIONS
  --order-by=index|key-asc  [default: index] Will be used in the export call as the order of the keys

EXAMPLE
  $ accent export

See code: src/commands/export.ts

accent help [COMMAND]

display help for accent

USAGE
  $ accent help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

accent jipt PSEUDOLANGUAGENAME

Export jipt files from Accent and write them to your local filesystem

USAGE
  $ accent jipt PSEUDOLANGUAGENAME

ARGUMENTS
  PSEUDOLANGUAGENAME  The pseudo language for in-place-translation-editing

EXAMPLE
  $ accent jipt

See code: src/commands/jipt.ts

accent stats

Fetch stats from the API and display it beautifully

USAGE
  $ accent stats

EXAMPLE
  $ accent stats

See code: src/commands/stats.ts

accent sync

Sync files in Accent and write them to your local filesystem

USAGE
  $ accent sync

OPTIONS
  --add-translations                Add translations in Accent to help translators if you already have translated
                                    strings

  --dry-run                         Do not write the file from the export _after_ the operation

  --merge-type=smart|passive|force  [default: smart] Will be used in the add translations call as the "merge_type" param

  --order-by=index|key-asc          [default: index] Will be used in the export call as the order of the keys

  --sync-type=smart|passive         [default: smart] Will be used in the sync call as the "sync_type" param

EXAMPLE
  $ accent sync

See code: src/commands/sync.ts

License

accent-cli is © 2019 Mirego and may be freely distributed under the New BSD license. See the LICENSE.md file.

About Mirego

Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of talented people who imagine and build beautiful Web and mobile applications. We come together to share ideas and change the world.

We also love open-source software and we try to give back to the community as much as we can.