Skip to content

CLI

Install and configure the novem CLI for use in a terminal or shell script.

AI-assisted, human-approvednovem uses AI to review and keep our documentation up to date.

Installation

Install the novem CLI from the Python Package Index using pipx, which keeps its dependencies in a separate environment. The source is available on GitHub.

Getting started

With pipx installed, run:

pipx install novem

Generate an API token and save the CLI configuration:

novem --init

Follow the authentication prompts. Once setup completes, use novem --help to list the commands available in your installed version.

Configuration and options

The novem CLI stores a configuration file in novem/novem.conf under the default config folder location. On Windows it uses LOCALAPPDATA or APPDATA, whilst on Linux and macOS it tries to use XDG_CONFIG_HOME but defaults to ~/.config/ if not present.

The configuration uses the INI format supported by Python's config parser. Each section starts with a [section] header, followed by key = value entries. Section names are case sensitive but keys are not. Leading and trailing whitespace is removed from keys and values.

The CLI and Python library share the configuration file. It contains general settings, application settings, and account profiles.

General

The [general] section sets defaults for applications using the file.

The currently supported global options are:

  • profile - the default profile to use
  • api_root - the API URL to use
[general]
profile = example_personal
api_root = https://api.novem.io/v1/

Application (app)

The application specific sections start with the string app followed by a colon :, after the colon follows the name of the novem application. Currently only fuse, cli and pylib are supported.

Application sections override the [general] values and set options for that application.

[app:cli]
profile = example_work        # select the work profile

Profile

The final section type is the profile sections. Profile sections start with the string profile: followed by a profile name. This is the value referred to in the [general] and [app] sections above.

The following example defines two fictional account profiles. Replace the usernames and tokens with your own.

[profile:example_personal]
username = example_personal
token_name = example-personal-token
token = <your-token>

[profile:example_work]
username = example_work
token_name = example-work-token
token = <your-token>

A profile name can differ from its username.

Appendix

For the full list of commands and flags available in the cli version you have installed, run novem -h (or novem --help).

Reference

Next
Plot