The Enlivy CLI lets you work with Enlivy from a terminal. It signs in as you, with exactly your rights, and is useful for developers who build Apps or automate their work.
This guide explains how to install it, sign in, and run your first commands.
Install the CLI
On macOS or Linux, run:
curl -fsSL https://cli.enlivy.com/install.sh | shIf you already use Node.js, you can install it with npm instead:
npm install -g @enlivy/cliCheck that it works:
enlivy --versionSign in
Run:
enlivy auth loginYour browser opens Enlivy’s sign in page. Sign in as you always do, choose which organizations the CLI may work in, and press Allow. Then go back to the terminal.
Working on a server without a browser? See Sign in without a browser.
Choose your organization
List the organizations you can work in, then pick one:
enlivy organizations list
enlivy config set organization <organization id>Run a command
Read your latest invoices, for example:
enlivy api GET /organizations/{organization}/invoices -q per_page=5{organization} is replaced with the organization you picked.
Common commands
| Command | What it does |
|---|---|
enlivy auth status | Shows who you are signed in as |
enlivy auth logout | Signs you out |
enlivy organizations list | Lists the organizations you can work in |
enlivy apps list | Lists the Apps you build |
enlivy --help | Lists every command |
Sign out or disconnect
Run enlivy auth logout. You can also disconnect the CLI from your Enlivy account, under Connected apps.