Skip to content

crodriguezanton/accent-cli

 
 

Repository files navigation

Accent CLI

Version Build Status

Usage

$ npm install -g accent-cli
+ accent-cli@0.4.0

$ accent COMMAND


$ accent (-v|--version|version)
accent-cli/0.3.0 darwin-x64 node-v8.5.0

$ 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

{
  "api": {
    "url": "http://your.accent.instance",
    "key": "2nziVSaa8yUJxLkwoZA"
  },
  "sync": [
    {
      "language": "fr",
      "format": "json",
      "path": "localization/fr/*.json",
      "hooks": {
        "afterSync": "touch sync-done.txt"
      }
    }
  ],
  "addTranslations": [
    {
      "language": "en",
      "format": "json",
      "path": "localization/en/*.json",
      "hooks": {
        "afterSync": "touch add-translations-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
  • path: 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))
  • hooks: List of hooks to be run

Hooks

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

  • beforeSync
  • afterSync
  • beforeAddTranslations
  • afterAddTranslations
  • beforeExport
  • afterExport

Commands

accent add-translations [FILENAME]

Add translations in Accent and write them to your local filesystem

USAGE
  $ accent add-translations [FILENAME]

OPTIONS
  --mergeType=smart|force|passive  [default: passive]
  --write                          Write the file from the export _after_ the operation

EXAMPLES
  $ accent add-translations
  $ accent add-translations Localization-admin

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 stats

Fetch stats from the API and display it beautifully

USAGE
  $ accent stats

EXAMPLE
  $ accent stats

accent sync [FILENAME]

Sync files in Accent and write them to your local filesystem

USAGE
  $ accent sync [FILENAME]

OPTIONS
  --write  Write the file from the export _after_ the operation

EXAMPLES
  $ accent sync
  $ accent sync Localization-admin

License

accent-cli is © 2018 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.

About

Sync, merge and export with the Accent API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.0%
  • Other 1.0%