Commands

Add census command options

CLI Reference

This page provides documentation for our command line tools.

cli

All command line entry point for the project.

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

# create-db

Create all the tables required for the project using alembic migrations.

Usage:

cli create-db [OPTIONS]

Options:

Name	Type	Description	Default
--db-url	text	Pass postgres connection details like postgresql://postgres:pass@db.host:5432/census or Set DB URL as environment variable like DB_URL="postgresql://postgres:pass@db.host:5432/census".	required
--help	boolean	Show this message and exit.	False

# mypy

mypy specific sub-commands.

Usage:

cli mypy [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

## run

mypy specific run sub-commands.

Usage:

cli mypy run [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

### add

Add run details.

Usage:

cli mypy run add [OPTIONS] PROJECT_NAME

Options:

Name	Type	Description	Default
--artifact-url	text	N/A	``
--run-info	json	N/A	{}
--mypy-coverage-file	path	N/A	required
--db-url	text	Pass postgres connection details like postgresql://postgres:pass@db.host:5432/census or Set DB URL as environment variable like DB_URL="postgresql://postgres:pass@db.host:5432/census".	required
--help	boolean	Show this message and exit.	False

### all

Display all the runs for the project.

Usage:

cli mypy run all [OPTIONS] PROJECT_NAME

Options:

Name	Type	Description	Default
--db-url	text	Pass postgres connection details like postgresql://postgres:pass@db.host:5432/census or Set DB URL as environment variable like DB_URL="postgresql://postgres:pass@db.host:5432/census".	required
--help	boolean	Show this message and exit.	False

### get-info

Get run info

Usage:

cli mypy run get-info [OPTIONS] RUN_ID

Options:

Name	Type	Description	Default
--db-url	text	Pass postgres connection details like postgresql://postgres:pass@db.host:5432/census or Set DB URL as environment variable like DB_URL="postgresql://postgres:pass@db.host:5432/census".	required
--help	boolean	Show this message and exit.	False

# project

Project specific sub-commands.

Usage:

cli project [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

## all

Displays all the projects in the database.

Usage:

cli project all [OPTIONS]

Options:

Name	Type	Description	Default
--db-url	text	Pass postgres connection details like postgresql://postgres:pass@db.host:5432/census or Set DB URL as environment variable like DB_URL="postgresql://postgres:pass@db.host:5432/census".	required
--help	boolean	Show this message and exit.	False

## create

Create a new project with the given details. If the name already exists, the project creation is skipped.

Usage:

cli project create [OPTIONS] NAME

Options:

Name	Type	Description	Default
--description	text	N/A	``
--url	text	N/A	``
--db-url	text	Pass postgres connection details like postgresql://postgres:pass@db.host:5432/census or Set DB URL as environment variable like DB_URL="postgresql://postgres:pass@db.host:5432/census".	required
--help	boolean	Show this message and exit.	False