Installing Alpic CLI
Install the CLI globally with npm or pnpm:
npm install -g alpic
# or
pnpm add -g alpic
Authentication
The CLI supports two authentication methods: browser-based login and API key.
Browser login
Opens a browser window to authenticate. Tokens are stored locally and reused across sessions.
API key
Set the ALPIC_API_KEY environment variable to authenticate without a browser:
Get your API key
In the Alpic dashboard, open your team and go to API Keys in the sidebar. Click New API key, name it, and copy the key. Set the environment variable
Export the key in your shell or add it to your CI/CD secrets:export ALPIC_API_KEY=your_api_key_here
Keep your API key secure and never commit it to version control. If exposed, revoke it in the dashboard and create a
new one.
Checking the version
Prints the installed CLI version.
Available Commands
deploy
Deploy a project to Alpic. Collects source files, uploads them, and waits for the deployment to complete.
Full reference →
login
Log in to Alpic by completing an OAuth flow in your browser. Stores tokens locally.
Full reference →
logout
Remove locally stored OAuth credentials.
Full reference →
whoami
Print the currently authenticated identity (OAuth user or API key team).
Full reference →
logs
Stream runtime logs for an Alpic environment.
alpic logs --environment-id <environmentId>
git connect
Link an Alpic project to a GitHub remote repository to enable automatic deployments.
Full reference →
git disconnect
Remove the GitHub remote repository link from an Alpic project.
Full reference →
telemetry enable
Opt this machine into anonymous CLI usage reporting.
Full reference →
telemetry disable
Opt this machine out of anonymous CLI usage reporting.
Full reference →
telemetry status
Show the current telemetry setting and anonymous machine ID for this installation.
Full reference →
environment-variable add
Add one or more environment variables to an Alpic environment.
alpic environment-variable add
environment-variable list
List all environment variables for an Alpic environment.
alpic environment-variable list
environment-variable remove
Remove an environment variable from an Alpic environment.
alpic environment-variable remove
environment-variable update
Update the value and/or secret status of an existing environment variable.
alpic environment-variable update
