Install Brass

One command. Works on macOS, Linux, Windows. Python 3.9+. No account, no API keys, no telemetry.

Recommended: pipx

pipx installs CLI tools into isolated virtualenvs so they don't pollute your Python environment.

# If you don't already have pipx:
$ brew install pipx # macOS
$ python3 -m pip install --user pipx # Linux / Windows
# Then:
$ pipx install brass-ai-coders

After install, the brassai CLI is on your $PATH.

Verify

$ brassai --help
Should print the usage banner and exit 0.

First scan

# From any project directory:
$ brassai --offline scan

Output lands in .brass/ as a small set of YAML files. The one you'll hand to your AI assistant is .brass/ai_instructions.yaml.

The --offline flag guarantees zero outbound network calls. It's optional; Brass is offline by default. The flag exists so you can be explicit about it.

Alternatives

  • pip in a virtualenv:python3 -m venv .venv && source .venv/bin/activate && pip install brass-ai-coders
  • From source (latest main):git clone https://github.com/coppersun/brass.git && cd brass/new_brass_system && pipx install -e .
  • Homebrew tap: coming with the public launch.
Requirements: Python 3.9+. Optional: Node.js 18+ if you want JS/TS scanning. Brass installs bandit, pylint, radon, detect-secrets, requests, and PyYAML as transitive dependencies.