Installation

Get the Acme CLI installed and connected to your backend in a couple of minutes. This guide was generated from the repository and stays in sync with each release.

Requirements

Node.js 20 or newer
An Acme workspace + access token
Git (for repository sync)

Install the CLI

Install globally with your preferred package manager:

npm install -g @acme/cli

pnpm add -g @acme/cli

yarn global add @acme/cli

Tip. Verify the install with acme --version.

Configure your project

Create an acme.config.ts at your project root:

import { defineConfig } from "@acme/cli";

export default defineConfig({
  apiUrl: process.env.ACME_API_URL,
  token: process.env.ACME_TOKEN,
  timeout: 30_000,
});

Never commit your token. Keep ACME_TOKEN in .env and add it to .gitignore.

Environment variables

Variable	Required	Description
`ACME_API_URL`	required	Base URL of your Acme backend instance.
`ACME_TOKEN`	required	Workspace access token (keep this secret).
`ACME_TIMEOUT`	optional	Request timeout in milliseconds. Defaults to 30000.

Next steps

Quick start →

Run your first command and fetch project data.

API reference →

Browse every endpoint with live code samples.

PreviousOverview NextQuick start

Last updated 2 days ago · Generated by RepoDocs.dev