Skip to main content

CLI

Overview

The CLI is a command line interface tool to interact with Conviso Platform.

The primary goal of the CLI is to be a developer friendly tool which automates different functionalities, letting users interact more easily with the platform.

You can use the CLI locally and also inside your CI/CD to be able to use the following features:

  • Perform security scans project (SAST, SCA, IaC, Container)
  • Set policies to block the pipeline depending on different criteria
  • Send diff versions of your source code application to later be reviewed by your own security team or Conviso's (when subscribed to our professional services license)

Requirements

To install the CLI some dependencies are required:

If you have system admin privileges just execute one of the following commands.

pip install conviso-flowcli

or

python3 -m pip install conviso-flowcli

If you haven't system admin privileges execute one of the following commands.

pip install --user conviso-flowcli

or

python3 -m pip install --user conviso-flowcli

Check if the installation command was well succeeded.

conviso --version

The command will print the current version and exit with success. Now we are ready to proceed.

CI/CD

For running the CLI in the CI/CD, please check the menu with all the different tools that we are integrated. If your tool is not there, please contact us to assess it.

Shell Completion

This section will guide you to activate the CLI shell completion feature. This is not required to use the tool, so you can skip it if you want.

Bash

Open your .bashrc file at ~/.bashrc and place the following snippet in the end of file.

CONVISO_COMPLETER="$(which flow_bash_completer.sh)"

[ -f "$CONVISO_COMPLETER" ] && {
source "$CONVISO_COMPLETER"
}

Start a new bash shell session and the shell completion will be available.

ZSH

Open your .zshrc file at ~/.zshrc and place the following snippet in the end of file.

CONVISO_COMPLETER="$(which flow_zsh_completer.sh)"

[ -f "$CONVISO_COMPLETER" ] && {
source "$CONVISO_COMPLETER"
}

Start a new ZSH shell session and the shell completion will be available.

Fish

Start a fish shell session and execute the following command.

mkdir -p ~/.config/fish/completions
cp (which flow_fish_completer.fish) ~/.config/fish/completions/flow.fish

Start a new fish shell session and the shell completion will be available.