The Ampersand Command Line Interface (CLI) enables you to deploy integrations and interact with the Ampersand platform.
To install the CLI using Homebrew (macOS users):
If you already have the CLI installed, and want to upgrade to the latest version, run:
Visit Ampersand CLI Releases.
Download the appropriate binary for your machine’s architecture.
Extract the downloaded folder containing the exe
file.
To use the CLI, open Command Prompt in the extracted folder:
cmd
and press EnterVerify the installation by running:
This should display a list of commands or options available in the CLI, confirming that it is properly configured and ready for use.
To make the CLI accessible from anywhere, add the folder to your PATH
:
exe
filePATH
(e.g. /usr/bin
).Note:
To ensure the CLI is accessible from anywhere, the binary must be placed in a directory listed in your PATH
. You can inspect your current PATH
using the following commands:
To check the version and build information of your CLI, run:
Ensure you have an Ampersand account. Create one on the Ampersand Dashboard if you don’t already have one.
To log into the CLI:
To log out:
Once you have defined your integrations in an amp.yaml
file, use the following commands to deploy:
To list all available commands and global flags:
Note: For detailed explanations of each command and its options, refer to the Command Reference section.
You can use the official Ampersand Github Action to automatically deploy integrations from your repository.
If you are using the official Github Action, or if you want to create your own CI/CD pipeline, you will need to generate an API key to run the CLI in a non-interactive mode that does not require a log in prompt.
key
flag.Alternatively, you can set the API key as an environment variable:
For more detailed output, run commands with the debug
flag.
The Ampersand Command Line Interface (CLI) enables you to deploy integrations and interact with the Ampersand platform.
To install the CLI using Homebrew (macOS users):
If you already have the CLI installed, and want to upgrade to the latest version, run:
Visit Ampersand CLI Releases.
Download the appropriate binary for your machine’s architecture.
Extract the downloaded folder containing the exe
file.
To use the CLI, open Command Prompt in the extracted folder:
cmd
and press EnterVerify the installation by running:
This should display a list of commands or options available in the CLI, confirming that it is properly configured and ready for use.
To make the CLI accessible from anywhere, add the folder to your PATH
:
exe
filePATH
(e.g. /usr/bin
).Note:
To ensure the CLI is accessible from anywhere, the binary must be placed in a directory listed in your PATH
. You can inspect your current PATH
using the following commands:
To check the version and build information of your CLI, run:
Ensure you have an Ampersand account. Create one on the Ampersand Dashboard if you don’t already have one.
To log into the CLI:
To log out:
Once you have defined your integrations in an amp.yaml
file, use the following commands to deploy:
To list all available commands and global flags:
Note: For detailed explanations of each command and its options, refer to the Command Reference section.
You can use the official Ampersand Github Action to automatically deploy integrations from your repository.
If you are using the official Github Action, or if you want to create your own CI/CD pipeline, you will need to generate an API key to run the CLI in a non-interactive mode that does not require a log in prompt.
key
flag.Alternatively, you can set the API key as an environment variable:
For more detailed output, run commands with the debug
flag.