# Overview of Flosum CLI Node.js Package
##  Overview
The Flosum CLI Node.js package provides command-line tools for working with DevOps projects. The DevOps-CLI extension for Visual Studio Code (VS Code) uses the tools in this package to streamline your work on DevOps projects by giving you direct access to Flosum CLI commands through an easy-to-use interface. However, if you want to use the Flosum CLI package directly, see the section below for more information.
### Installing Flosum CLI
{% hint style="success" %}
#### Node.js
Minimum Version: Node v24.0.0 & npm v11
The Flosum DevOps-CLI extension uses the **Flosum CLI**, a Node.js package. Node.js is required to install and use Flosum CLI.
{% endhint %}
{% hint style="warning" %}
#### Insall or Runtime Error
If you run into installation or runtime errors with the flosum Node.js package, such as `flosum:ERROR The "path" argument must be of type string. Received undefined`, try Node.js v22.14.0 with npm v10.9.2.
{% endhint %}
1. Open a terminal.
2. Run the following command to install the package.
```shellscript
npm i -g @flosum/cli
```
3. Once the package is installed, confirm it by running this command.
{% code overflow="wrap" expandable="true" %}
```shellscript
flosum --version
```
{% endcode %}
4. If the **flosum** package displays a version number, you have successfully installed the Flosum CLI package.
### Using Flosum CLI
Review the Flosum CLI package README.md below for a list of available commands and an explanation of what each one does. Because the DevOps-CLI Extension calls these commands, you can also review the following article for more detailed instructions.
* [Using DevOps CLI in VS Code](/devops/code/devops-cli/using-devops-cli-in-vs-code.md)
Flosum CLI README.md
## @flosum/cli
CLI tool for Flosum operations.
### Prerequisites
* Node.js LTS (22.x or newer)
* npm 9+
### Commands
#### 1. flosum commands
```bash
flosum login [options]
```
**Description**
Login into global settings and retrieve data about related services.
**Options:**
1. -a, --alias \\
: Optional. Alias which saved credentials will be accessed with (default: "default").
2. -t, --token \\
: Optional. Token for getting access to flosum services. If not specified it will be requested during command execution.
3. \--json: Optional. Applies json formatted result (default: false).
4. -h, --help: Optional. Display help for command.
```bash
flosum logout [options]
```
**Description**
Delete saved credentials.
**Options:**
1. -a, --alias \\
: Optional. Alias which saved credentials will be accessed with (default: "default").
2. \--json: Optional. Applies json formatted result (default: false).
3. -h, --help: Optional. Display help for command.
```bash
flosum logout [options]
```
**Description**
Display all authorized credentials.
**Options:**
1. \--json: Optional. Applies json formatted result (default: false).
2. -h, --help: Optional. Display help for command.
#### 2. flosum devops commands
```bash
flosum devops init [options]
```
**Description**
Create salesforce project and cli system files.
**Options:**
1. -n, --name \\
: Optional. A name of a folder where a project will be stored. If not specified it will be requested during command execution.
2. \--json: Optional. Applies json formatted result (default: false).
3. -h, --help: Optional. Display help for command.
```bash
flosum devops clone [options]
```
**Description**
Initialize salesforce project and retrieve "main" branch from registered devops tenant.
**Options:**
1. -n, --name \\
: Optional. A name of a folder where a project will be stored. If not specified it will be requested during command execution.
2. \--json: Optional. Applies json formatted result (default: false).
3. -h, --help: Optional. Display help for command.
```bash
flosum devops checkout [options]
```
**Description**
Checkout on another branch. Checkout command retrieves components missing locally.
**Options:**
1. -b, --branch \\
: Optional. A branch name which you checkout on. If not specified it will be requested during command execution.
2. \--json: Optional. Applies json formatted result (default: false).
3. -h, --help: Optional. Display help for command.
```bash
flosum devops config-set [options]
```
**Description**
Set project config.
**Arguments:**
1. config-name: Required.Config name. Allowed values: credentialsAlias(string).
2. value: Required. Config value.
**Options:**
1. \--json: Optional. Applies json formatted result (default: false).
2. -h, --help: Optional. Display help for command.
```bash
flosum devops config-unset [options]
```
**Description**
Clear project config property.
**Arguments:**
1. config-name: Required.Config name. Allowed values: credentialsAlias.
**Options:**
1. \--json: Optional. Applies json formatted result (default: false).
2. -h, --help: Optional. Display help for command.
```bash
flosum devops pull [options]
```
**Description**
Pull latest branch commit from devops.
**Options:**
1. \--json: Optional. Applies json formatted result (default: false).
2. -h, --help: Optional. Display help for command.
```bash
flosum devops commit [options]
```
**Description**
Commit local changes to a remote branch on devops.
**Options:**
1. -m, --message \\
: Optional. Commit message. If not specified it will be requested during command execution.
2. \--json: Optional. Applies json formatted result (default: false).
3. -h, --help: Optional. Display help for command.
```bash
flosum devops rollback [options]
```
**Description**
Roll back your branch state to last committed one.
**Options:**
1. \--json: Optional. Applies json formatted result (default: false).
2. -h, --help: Optional. Display help for command.
```bash
flosum devops status [options]
```
**Description**
Return all local not committed changes.
**Options:**
1. \--json: Optional. Applies json formatted result (default: false).
2. -h, --help: Optional. Display help for command.
```bash
flosum devops list-branches [options]
```
**Description**
List all remote branches.
**Options:**
1. \--json: Optional. Applies json formatted result (default: false).
2. -h, --help: Optional. Display help for command.
### License
ISC © Flosum
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.flosum.com/devops/code/devops-cli/overview-of-flosum-cli-node.js-package.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.