CLI
Overviewâ
The Conviso CLI is a command-line interface for interacting with the Conviso Platform through GraphQL.
It is designed for:
- local operational workflows;
- security automation;
- CI/CD execution;
- bulk import and export tasks.
Compatibility Note: All examples below use cvs (the recommended short alias). You can also use conviso instead â both commands work identically:
cvs projects list # Recommended (shorter)
conviso projects list # Also works (fully compatible)
Repository:
Requirementsâ
- Python 3.10+
- API Key from Conviso Platform (get at: https://app.convisoappsec.com/spa/company/[COMPANY_ID]/api-keys)
- Optional:
CONVISO_API_TIMEOUT(seconds, default30)
Installâ
Option 1: From PyPI (Recommended)â
pip install conviso-cli
cvs --version
Option 2: From Source (Development)â
git clone https://github.com/convisolabs/conviso-cli.git
cd conviso-cli
pip install -e .
cvs --version
Authenticationâ
Secure Credential Storage (Recommended)â
cvs auth login
This will prompt for your API key and save it securely to ~/.config/cvs/credentials.
Using Environment Variablesâ
Alternatively, set your API key in your shell or .env file:
export CONVISO_API_KEY="<your_api_key>"
Or in a local .env file:
echo "CONVISO_API_KEY=<your_api_key>" > .env
Priority Orderâ
The CLI looks for API key in this order:
CONVISO_API_KEYenvironment variable.envfile in current directory~/.config/cvs/credentials(saved bycvs auth login)
Check Login Statusâ
cvs auth whoami
Update CLIâ
pip install --upgrade conviso-cli
Built-in upgrade command (for development installations):
cvs upgrade
Command Patternâ
Most commands follow:
cvs <group> <action> [options]
Or use the shorter alias:
cvs <group> <action> [options]
Common command groups currently documented in the CLI repository include:
projectsassetsrequirementstasksvulnssbombulkaccesscontrol
The top-level CLI also exposes:
upgrade
Output and Paginationâ
Many list commands support options such as:
--allto fetch all pages--pageand--per-pageor--limitfor pagination control--format table|json|csv--output <file>for file export
Some commands support additional output formats depending on the resource, such as sarif or cyclonedx.
Usage Examplesâ
The examples below reflect the current usage examples documented in the CLI repository README together with the command tree currently registered in the CLI source code.
Command Catalogâ
The currently available command groups and actions are:
projects:list,requirements,create,update,status,deleteassets:list,create,update,deleterequirements:list,project,activities,create,update,deletetasks:create,list,runtasks approvals:list,clear,removevulns:list,timeline,create,update,check-sca-patchessbom:list,import,check-vulnsbulk:assets,requirements,vulnsaccesscontrol:user-profile,user-teams,bulk-users- top-level:
upgrade,security-gate
Projectsâ
List all projects:
cvs projects list --company-id 443 --all
List projects filtered by assignee:
cvs projects list \
--company-id 443 \
--filter assignee=analyst@company.com \
--all
List project requirements and activities:
cvs projects requirements --project-id 12345
Create a project:
cvs projects create \
 --company-id 443 \
 --name "New Project" \
 --goal "Validate scope" \
 --scope "External perimeter" \
 --type-id 14 \
 --start-date 2026-05-19 \
 --estimated-hours 2 \