@flosum/cli
v0.0.1
Published
Devops cli
Keywords
Readme
@flosum/cli
CLI tool for Flosum operations.
Prerequisites
- Node.js LTS (22.x or newer)
- npm 9+
Commands
1. flosum commands
flosum login [options]Description
Login into global settings and retrieve data about related services.
Options:
- -a, --alias \
: Optional. Alias which saved credentials will be accessed with (default: "default").
- -t, --token \
: Optional. Token for getting access to flosum services. If not specified it will be requested during command execution.
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum logout [options]Description
Delete saved credentials.
Options:
- -a, --alias \
: Optional. Alias which saved credentials will be accessed with (default: "default").
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum logout [options]Description
Display all authorized credentials.
Options:
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
2. flosum devops commands
flosum devops init [options]Description
Create salesforce project and cli system files.
Options:
- -n, --name \
: Optional. A name of a folder where a project will be stored. If not specified it will be requested during command execution.
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops clone [options]Description
Initialize salesforce project and retrieve "main" branch from registered devops tenant.
Options:
- -n, --name \
: Optional. A name of a folder where a project will be stored. If not specified it will be requested during command execution.
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops checkout [options]Description
Checkout on another branch. Checkout command retrieves components missing locally.
Options:
- -b, --branch \
: Optional. A branch name which you checkout on. If not specified it will be requested during command execution.
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops config-set [options] <config-name> <value>Description
Set project config.
Arguments:
- config-name: Required.Config name. Allowed values: credentialsAlias(string).
- value: Required. Config value.
Options:
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops config-unset [options] <config-name>Description
Clear project config property.
Arguments:
- config-name: Required.Config name. Allowed values: credentialsAlias.
Options:
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops pull [options]Description
Pull latest branch commit from devops.
Options:
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops commit [options]Description
Commit local changes to a remote branch on devops.
Options:
- -m, --message \
: Optional. Commit message. If not specified it will be requested during command execution.
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops rollback [options]Description
Roll back your branch state to last committed one.
Options:
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops status [options]Description
Return all local not committed changes.
Options:
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
flosum devops list-branches [options]Description
List all remote branches.
Options:
- --json: Optional. Applies json formatted result (default: false).
- -h, --help: Optional. Display help for command.
License
ISC © Flosum
