axinstall
v1.3.0
Published
Universal installer for AI CLI agents (defaults to npm)
Maintainers
Readme
axinstall
Install AI CLI agents (Claude Code, Codex, Gemini, etc.) in any environment.
Quick Start
# Install Claude Code globally
npx -y axinstall "claude"
# Install with a specific package manager
npx -y axinstall "claude" --with "npm"
# Preview what would be installed (dry run)
npx -y axinstall "claude" --dry-run
# List supported agents
npx -y axinstall --list-agents
# Check installed agents and available package managers
npx -y axinstall --status
# Enable verbose output
npx -y axinstall "claude" --verbosePrerequisites
- Node.js >=22.14.0
- Use
pnpm dlx(recommended) ornpx(bundled with npm) for one-off runs - Examples assume a POSIX shell (sh/bash/zsh); adjust for PowerShell or CMD
By default, axinstall installs agents using npm. This means npm must be
available unless you explicitly override the installer:
--with <installer>(e.g.,--with "pnpm")AXINSTALL_WITH=<installer>
Supported installers:
- npm
- pnpm
- bun
- yarn
- Homebrew (
brew)
Conventions
- Prefer long flags in scripts (
--verboseinstead of-v) - Examples include explicit quoting for flag values and arguments
Custom Paths
Override the default binary lookup by setting environment variables:
export AXINSTALL_NPM_PATH=/path/to/npm
export AXINSTALL_PNPM_PATH=/path/to/pnpm
export AXINSTALL_BUN_PATH=/path/to/bun
export AXINSTALL_YARN_PATH=/path/to/yarn
export AXINSTALL_BREW_PATH=/path/to/brewExamples
Install agents
# Install using npm (default)
npx -y axinstall "claude"
npx -y axinstall "codex"
npx -y axinstall "gemini"
# Force a specific package manager
npx -y axinstall "claude" --with "npm"
npx -y axinstall "opencode" --with "brew"
# Install locally (not globally)
npx -y axinstall "claude" --localPipeline examples
# Get list of agent CLI names
npx -y axinstall --list-agents | tail -n +2 | cut -f1
# Find agents from a specific provider
npx -y axinstall --list-agents | tail -n +2 | awk -F'\t' '$4 == "Anthropic" {print $1}'
# Get available installers only
npx -y axinstall --status --only "installers" | tail -n +2 | awk -F'\t' '$4 == "available" {print $2}'
# Count installed vs not found agents
npx -y axinstall --status --only "agents" | tail -n +2 | cut -f4 | sort | uniq -cOutput
--list-agents prints a tab-separated header and rows with columns:
CLI NAME PACKAGE PROVIDER--status prints a tab-separated header and rows with columns:
TYPE ID NAME STATUS VERSION PROVIDER PACKAGETYPEvalues:AGENT|INSTALLERSTATUSvalues:- for
AGENT:installed|not_found - for
INSTALLER:available|not_found
- for
--onlyvalues:"all"|"agents"|"installers"
Agent Rule
Add to your CLAUDE.md or AGENTS.md:
# Rule: `axinstall` Usage
Run `npx -y axinstall --help` to learn available options.
Use `axinstall` to install AI CLI agents in any environment. It uses the
requested package manager (via `--with` / `AXINSTALL_WITH`) and uses npm
by default.License
MIT
