CLI Installation - Autoposting

Prerequisites

Node.js 20 or later

Install

npm
npx (one-shot)

npm install -g @autoposting.ai/cli

npx @autoposting.ai/cli posts list

Both autoposting and ap (short alias) are available after install.

Setup

Authenticate

Set your API key via environment variable or browser login:

Environment Variable
Browser Login

export AUTOPOSTING_API_KEY=sk-social-your-key

Add to your shell profile (~/.zshrc, ~/.bashrc) for persistence.

ap auth login

Opens your browser for authentication. Credentials are stored in ~/.config/autoposting/credentials.json with 0600 permissions. Use --profile <name> to keep several accounts, and --api-key <key> to store a key without the browser flow.

Auth priority:

--api-key flag  >  AUTOPOSTING_API_KEY env  >  ~/.config/autoposting/credentials.json

The CLI talks to https://app.autoposting.ai/api-proxy by default. Override it with the AUTOPOSTING_BASE_URL environment variable (or ap auth login --base-url) for staging or self-hosted backends.

Verify

ap doctor

Checks CLI version, Node.js version, authentication, and API connectivity.

ap whoami

Shows which auth method is active and the associated workspace.

Shell Completions (optional)

zsh
bash
fish
PowerShell

ap completion zsh >> ~/.zshrc
source ~/.zshrc

ap completion bash >> ~/.bashrc
source ~/.bashrc

ap completion fish > ~/.config/fish/completions/ap.fish

ap completion powershell >> $PROFILE

CI/CD Usage

For CI/CD pipelines, use the AUTOPOSTING_API_KEY environment variable with --json and --quiet flags:

# GitHub Actions
- name: Announce release
  run: |
    npm install -g @autoposting.ai/cli
    ap posts create \
      --brand my-brand \
      --text "v${{ github.ref_name }} is live!" \
      --platforms x,linkedin \
      --json
  env:
    AUTOPOSTING_API_KEY: ${{ secrets.AUTOPOSTING_API_KEY }}

Exit Codes

Code	Meaning
0	Success
1	General error
2	Authentication error
3	Validation error
4	Not found
5	Rate limited
6	Server error

Commands

Full command reference with flags and examples.

MCP Setup

Connect AI assistants to your account.

TypeScript SDK

Programmatic API access in Node.js.

API Reference

Explore the REST API directly.

​Prerequisites

​Install

​Setup

​CI/CD Usage

​Exit Codes

Commands

MCP Setup

TypeScript SDK

API Reference

Prerequisites

Install

Setup

CI/CD Usage

Exit Codes