Usage

Start Command

This is where the CLI does its magic. It creates two sessions from repos given using tmux and builds workspaces into them.

$ parasut-cli start -e <repo-name> -s <repo-name>

• -e/--edit - a repository name to open in text editor. Choices: server, billing, phoenix, shared-logic, trinity, ui-library, client, e-doc-broker, post-office, ubl-validator, printX.

• -s/--setup - a repository name to launch. Choices: server, billing, phoenix, shared-logic, trinity, ui-library, client, e-doc-broker, post-office, ubl-validator, printX.

• -w/--worker - a worker name to launch. This is necessary when you working with e-invoice. Choices: server-worker, e-doc-broker-worker.

Note

You can access existing tmux sessions with this command.

$ tmux list-sessions
$ tmux a -t <session_name>

Link Command

This command does the linking work of yarn. It takes the given argument and writes it to package.json in the current repo for you. It also includes a logic so that you can undo any changes you have made later (-u/--undo).

$ parasut-cli link -b <repo-name> -t <repo-name>
$ parasut-cli link -b <repo-name> -t <repo-name> --output
$ parasut-cli link -b <repo-name> -t <repo-name> <repo-name> --output

• -b/--base - a repository name for linking target repository. Use this with -t/--target option. Choices: phoenix, trinity.

• -t/--target - a target repository name for linking it to base repository. Choices: ui-library, shared-logic.

• -u/--undo - a repository name for unlinking. Choices: ui-library, shared-logic.

• --list - a repository name for unlinking it list linked repos of base repo.

• --output - an option for showing process output.

Note

-b/–base argument is necessary. Command will continue to ask until the required base repo is given.

Switch Command

This part can be a little confusing. It represents exactly what it does. Switch processes run on server and billing. What the command does is to automate processes that are executed interactively in the background.

$ parasut-cli switch <switch-name> -t <switch-choice>

• frontend - a repository name to switch frontend repo on server.

  • -t/--target - target prefix for choosing choices. Choices: phoenix, trinity.

  • --output - an option for showing process output.

• addlings - command for switching addlings.

  • -t/--target - target prefix for choosing choices. Choices: receipt, invoice.

  • --output - an option for showing process output.

• pricing_list - command for switching addlings.

  • -t/--target - target prefix for choosing choices. Choices: trinity, phoenix.

  • --output - an option for showing process output.

Run Command

This command runs the chain of commands required to instantiate the repository. Selects yarn, node and ruby versions and related options for the target repo.

$ parasut-cli run -t <repo-name>

• -t/--target - a repository name for running target repository with necessary options. Choices: server, server-sidekiq, billing, billing-sidekiq, e-doc-broker, e-doc-broker-sidekiq, post-office, post-office-sidekiq, ubl-validator, phoenix, shared-logic, trinity, ui-library, client, printX.

Release Command

It does the “release” operation on the target repo. It does simply sets the registry, logs in to the npm, publishes the package, and deletes the registry.

$ parasut-cli release -t <repo-name>
$ parasut-cli release -t <repo-name> --output
$ parasut-cli release -t <repo-name> --pre-release --output

• -t/--target - a repository name for publish release to target repository. Choices: shared-logic, ui-library.

• --pre-release - an option for making pre-release from your local branch (beta).

• --auto-login - an option for logging in to npm automatically.

• --output - an option for showing process output.

Note

You have to set these environment variables be able to release the target repo:

$ export PARASUT_NPM_USERNAME=<npm_username>
$ export PARASUT_NPM_PASSWORD=<npm_password>
$ export PARASUT_NPM_EMAIL=<npm_email>

Also, if you want to login to npm without entering username and password, you are lucky because parasut-cli has a flag for this: --auto-login. But first, you have to install the third party package below; after the installation you can use --auto-login flag.

$ npm install -g npm-cli-login
$ parasut-cli release -t <repo-name> --auto-login
$ parasut-cli release -t <repo-name> --auto-login --output
$ parasut-cli release -t <repo-name> --pre-release --auto-login --output

Version Command

You can use this command to show the version of the CLI.

$ parasut-cli -v
$ parasut-cli --version

Help Command

Generally, the CLI will not make you do anything against the rules and will give you the necessary warnings when the time comes. If you are confused, type -h/--help at the end of your chain of commands:

$ parasut-cli -h
$ parasut-cli start --help
$ parasut-cli start -b <repo-name> --help
$ parasut-cli switch --help