/cosmo-cli

Command-line interface (CLI) tool for the Cosmo API.

Primary LanguageRustApache License 2.0Apache-2.0

Cosmo Exein Logo


The command-line interface tool that allows you to interact with the Cosmo API.

With the Cosmo CLI tool you are able to manage your projects, run scans, generate reports or manage your API keys to interface directly with the API. For more info read the docs.

A GIF highlighting the simple usage of the Cosmo CLI to list projects and fetch details of a specific project.

Build

Requires a recent version of Rust.

cargo build --release

Usage

Description Command
Setup the api key cosmo setup
List personal projects cosmo list
cosmo ls
List personal projects (output in json) cosmo list --output json
Create a new analysis * cosmo create --file <FILE> --name <NAME> --type <TYPE> --subtype <SUBTYPE>
cosmo new --file <FILE> --name <NAME> --type <TYPE> --subtype <SUBTYPE>
View project results overview cosmo overview --id <PROJECT_ID>
cosmo show --id <PROJECT_ID>
View analysis results* cosmo analysis --id <PROJECT_ID> --analysis <ANALYSIS>
View analysis results (output in json) cosmo analysis --id <PROJECT_ID> --analysis <ANALYSIS> --output json
View paginated analysis results* cosmo analysis --id <PROJECT_ID> --analysis <ANALYSIS> --page 1 --per-page 10
Delete project cosmo delete --id <PROJECT_ID>
cosmo rm --id <PROJECT_ID>
Create an API key cosmo apikey --action create
List API key cosmo apikey --action list
Save PDF report cosmo report --id <PROJECT_ID>
List organizations cosmo organization list
Create an organization cosmo organization create --name <NAME> --description <DESCRIPTION>
Delete an organization cosmo organization delete --id <ORGANIZATION_ID>

Note: use cosmo list to retrieve a <PROJECT_ID>

Supported analysis

Linux/Container Analysis

  • hardening
  • cve-check
  • security-scan
  • password-hash
  • crypto
  • nvram
  • kernel
  • software-bom
  • static-code

Container/Docker Lite Analysis

  • cve-check

UEFI Analysis

  • access
  • intel-boot-guard
  • surface
  • secure-boot
  • uefi-security-scan
  • peim-dxe

Vxworks Analysis

  • functions
  • symbols
  • tasks
  • capabilities

Supported types

type subtype
linux generic
linux yocto
linux buildroot
linux openwrt
container docker
container docker-lite
container lxc
uefi generic
vxworks generic

Contributing

To contribute to the project please refer to our contribution guidelines.

License

Copyright (c) Exein SpA. All rights reserved.

Licensed under the Apache License 2.0 license.