traduz-cli v0.3.0

traduz-cli

CLI to handle strings translations

• Installation
• Usage
• Commands

Installation

• Install minimum needed Node.JS version pointed on "engines" field on package.json in your system
• If you use yarn as package manager (recommended):
  • Run in your terminal the following command to install the package:

  yarn global add 'git+ssh://git@github.com/useflow-app/traduz-cli.git#main'

• Test if everything is working as intended, running the following command:

  traduz-cli

  • If your terminal can't find the command, make sure you are with yarn global binaries on your PATH:

  echo $PATH

  • To add yarn global binaries to your path:
    • If you use ZSH:

    echo -n 'export PATH="$(yarn global bin):$PATH"' >> ~/.zshrc && source ~/.zshrc

    • If you use BASH:

    echo -n 'export PATH="$(yarn global bin):$PATH"' >> ~/.bashrc && source ~/.bashrc

• If you use npm as package manager:
  • Make sure you are using an version <= 8.11.0, as newer versions have issues installing it.
    • If you're using an newer version, you can downgrade it by running:

    npm install -g npm@8.11.0

  • Run in your terminal the following command to install the package:

    npm install -g 'git+ssh://git@github.com/useflow-app/traduz-cli.git#main'

  • Test if everything is working as intended, running the following command:

    traduz-cli

• It should show you the "help" with available commands ready to use :D

Usage

$ npm install -g traduz-cli
$ traduz-cli COMMAND
running command...
$ traduz-cli (--version)
traduz-cli/v0.3.0 linux-x64 node-v16.18.1
$ traduz-cli --help [COMMAND]
USAGE
  $ traduz-cli COMMAND
...

Commands

• traduz-cli setup
• traduz-cli update

traduz-cli setup

setup i18n cli

USAGE
  $ traduz-cli setup

DESCRIPTION
  setup i18n cli

EXAMPLES
  $ traduz-cli setup

See code: dist/commands/setup.ts

traduz-cli update

update supported languages

USAGE
  $ traduz-cli update [-f] [-r]

FLAGS
  -f, --force  force send all strings
  -r, --reset  reset local translations

DESCRIPTION
  update supported languages

EXAMPLES
  $ traduz-cli update

See code: dist/commands/update.ts