Skip to content
Apothem
How-to guides

Add a harness

Enable a harness adapter so its native configuration is materialized from the shared profile.

Goal: enable one more harness so Apothem materializes that harness's native configuration from your shared profile.

Prerequisites

  • A shared profile at ~/.config/apothem/profile.yaml (create one with apothem profile init if it does not yet exist).
  • The apothem CLI on your PATH. If you installed the self-contained source tree, prefix each command with PYTHONPATH="$HOME/.apothem/src" and run python -m apothem in place of apothem — or use npx @ahmed-g-gad/apothem.

Steps

  1. List the registered harnesses and see which are already installed:

    apothem harnesses list

    apothem harnesses list prints every supported id; the same set is in the harness list and the source-generated harness registry. Pick the id for your tool rather than hardcoding the list here — it grows as adapters are added.

  2. Inspect the target harness to confirm its scope and output path:

    apothem harnesses show cursor

    A Scope: project line means the adapter materializes into a project tree and requires --project PATH; Scope: user materializes into a user-scope configuration directory and needs no project flag.

  3. Preview the install without writing files:

    apothem install --harness cursor --dry-run
  4. Install the harness. For a user-scope harness:

    apothem install --harness claude-code

    For a project-scope harness, pass the project root:

    apothem install --harness cursor --project /path/to/project

    Install every supported harness at once with --harness all (project-scope harnesses still need --project; ids listed in exclude_harnesses in the profile are skipped).

Verify

apothem verify --harness cursor

A ✓ <harness-id> is verified line confirms the managed targets exist and parse. apothem doctor gives the whole-system view across every harness.

On this page