ChartnautDocs

Install

The CLI installs with one command. It is a single program with nothing else to set up: you do not need Node or any other runtime.

The same commands are on the Developers page, in the menu under your name, with a copy button beside each.

Both install scripts are in the chartnaut/cli repository on GitHub, so you can read exactly what runs before piping it to a shell. To build the CLI from source instead, follow the README.

Screenshot to capture · 4:3 · cli-install-developers-card
The Chartnaut CLI card on the Developers page, with the install commands
Route/morpheus/settings/developers
FocusThe Chartnaut CLI section: its heading, the Install commands for macOS / Linux and Windows (PowerShell), and the three numbered steps below them
StateSigned in on a Starter or higher plan so the page is the normal developer view
Sourceclient/src/routes/authenticated/morpheus/settings/ApiTokens/DevelopersCliSection.tsx:32 DevelopersCliSection
The Chartnaut CLI card on the Developers page, with the install commands.

macOS and Linux

In a terminal, run:

curl -fsSL https://chartnaut.com/install.sh | sh

The script picks the build for your machine: Apple silicon or Intel on macOS, x64 or ARM on Linux, including Alpine. It downloads it, checks its SHA-256 checksum, and installs it to ~/.chartnaut/bin/chartnaut. If that folder is not on your PATH, it adds a line to your shell's profile (.zshrc, .bashrc, .bash_profile, fish's config.fish or .profile) and prints the line to run in the current terminal.

Installing Chartnaut CLI 0.1.0 (darwin-arm64)
✓ installed /Users/jane/.chartnaut/bin/chartnaut
✓ added /Users/jane/.chartnaut/bin to PATH in /Users/jane/.zshrc

Open a new terminal, or run:  export PATH="/Users/jane/.chartnaut/bin:$PATH"

Windows

In PowerShell, run:

irm https://chartnaut.com/install.ps1 | iex

It installs chartnaut.exe to %LOCALAPPDATA%\Chartnaut\bin and adds that folder to your user PATH. It does not need administrator rights. The build is 64-bit, and ARM Windows runs it under emulation. Other terminal windows see the new PATH once you open them again.

Check it works

Open a new terminal and run:

$ chartnaut --version
0.1.0

Then sign in.

Installer options

These variables change what the installer does. On macOS and Linux, put one before sh: curl -fsSL https://chartnaut.com/install.sh | CHARTNAUT_VERSION=0.1.0 sh. In PowerShell, set it first with $env:CHARTNAUT_VERSION = "0.1.0", then run the install command.

Variable

Does

CHARTNAUT_VERSION

Installs this version instead of the latest

CHARTNAUT_INSTALL

Installs under this folder instead. The program goes in its bin folder

CHARTNAUT_NO_MODIFY_PATH=1

Leaves your PATH alone

Update

$ chartnaut upgrade
chartnaut updated 0.1.0 → 0.2.0

chartnaut upgrade downloads the latest version, checks its checksum and replaces itself. If the checksum does not match, nothing changes. chartnaut upgrade --check only tells you whether a newer version exists. Running the install command again also installs the latest version.

Uninstall

  1. Run chartnaut logout. It revokes this computer's key and deletes the saved copy.

  2. Delete the install folder: ~/.chartnaut on macOS and Linux, %LOCALAPPDATA%\Chartnaut on Windows.

  3. Remove the PATH line. On macOS and Linux it sits under # Chartnaut CLI in the profile file the installer named. On Windows, remove %LOCALAPPDATA%\Chartnaut\bin from your user PATH in the Windows environment variable settings.

If the install fails

You see

What to do

checksum mismatch … Nothing was installed.

The download was damaged or changed on the way. Run the command again.

the … build does not run on this machine. Nothing was installed.

The installer tested the program before replacing anything and it would not start. Tell support which system you are on.

unsupported CPU architecture or unsupported operating system

There is no build for this machine. The CLI runs on 64-bit macOS, Linux and Windows.

this installer needs curl or wget, or needs sha256sum or shasum

Install the tool it names, then run it again.

chartnaut: command not found after installing

The terminal was open before the PATH changed. Open a new one, or run the export PATH=… line the installer printed.