Skip to main content

​
Installing Alpic CLI

Install the CLI globally with npm or pnpm: 
npm install -g alpic
# or
pnpm add -g alpic
Run it without installing via npx: 
npx alpic <command>

​
Authentication

The CLI supports two authentication methods: browser-based login and API key. 
alpic 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:
1

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.
2

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
If both OAuth login credentials and ALPIC_API_KEY are present, the CLI uses ALPIC_API_KEY.
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

alpic --version
Prints the installed CLI version.

​
Available Commands

CommandWhat it doesFull reference
team listList teams for the current userView docs
team inspectShow details of a team and its projectsView docs
project listList projectsView docs
project inspectShow details of a project and its environmentsView docs
environment listList environments for a projectView docs
environment inspectShow details of an environmentView docs
auditRun a beacon audit on an MCP serverView docs
linkLink the current directory to an Alpic projectView docs
deployDeploy a project from the current directory or a specified pathView docs
publishPublish an MCP server to the MCP registryView docs
deployment listList deployments for the current projectView docs
deployment inspectShow details of a specific deploymentView docs
deployment logsRetrieve build logs for a deploymentView docs
loginAuthenticate via browser OAuthView docs
logoutRemove stored OAuth credentialsView docs
whoamiShow the current authenticated identityView docs
logsStream runtime logs for an Alpic environmentView docs
git connectLink a project to a git remote repositoryView docs
git disconnectUnlink a project from its git remote repositoryView docs
environment-variable addAdd one or more environment variables to an Alpic environmentView docs
environment-variable listList all environment variables for an Alpic environmentView docs
environment-variable removeRemove an environment variable from an Alpic environmentView docs
environment-variable updateUpdate the value and/or secret status of an existing environment variableView docs
playground enableEnable the playground for an environmentView docs
playground disableDisable the playground for an environmentView docs
playground statusShow playground configuration for an environmentView docs
playground configureSet the playground server name and descriptionView docs
playground example-prompt addAdd an example prompt to the playground (max 3)View docs
playground example-prompt listList playground example prompts for an environmentView docs
playground example-prompt removeRemove an example prompt from the playgroundView docs
playground headers addAdd a header to the playground configurationView docs
playground headers listList playground headers for an environmentView docs
playground headers removeRemove a playground headerView docs
telemetry enableOpt this machine into anonymous CLI usage reportingView docs
telemetry disableOpt this machine out of anonymous CLI usage reportingView docs
telemetry statusShow the current telemetry setting and anonymous machine IDView docs
tunnelExpose a local server to the internet through an Alpic tunnelView docs