Skip to main content

Agentic Beacon CLI

CLI tool for distributing agentic engineering contexts, knowledge, and skills from a warehouse repository to project .opencode directories.

Overview

This tool enables the DRY (Don't Repeat Yourself) principle for agentic knowledge management:

  • Centralized warehouse: Store all contexts, knowledge, and skills in one place
  • Fork workflow: Fork the warehouse template to create your organization's warehouse
  • Local distribution: Use the CLI to distribute content to gitignored .opencode folders in projects
  • Easy updates: Sync latest changes from the warehouse with one command

Installation

The best way to install abc is using uv tool install, which installs it in an isolated environment:

# Install once, use anywhere
uv tool install agentic-beacon

# Verify installation
abc --help

# Update to latest version
uv tool upgrade agentic-beacon

# Uninstall
uv tool uninstall agentic-beacon

Alternative Installation Methods

# Using pipx (similar to uv tool, isolated environment)
pipx install agentic-beacon

# Using pip (global Python environment)
pip install agentic-beacon

# One-off execution without installation
uvx --from agentic-beacon abc init my-warehouse

Usage

All examples below use the abc command directly (after installation).

1. List Available Content

# List all available contexts, knowledge, and skills
abc list

# From a specific warehouse location
abc list --warehouse /path/to/warehouse

2. Setup (First Time)

# Interactive mode (recommended for first time)
abc setup --interactive

# Install specific content
abc setup \
  --context global \
  --context python \
  --knowledge global \
  --knowledge languages/python \
  --skill example-skill

# Install everything
abc setup --all

# Specify warehouse and project locations
abc setup --all \
  --warehouse /path/to/warehouse \
  --project /path/to/project

What it does:

  • Creates .opencode/ directory in your project (gitignored)
  • Copies selected contexts to .opencode/contexts/
  • Copies selected knowledge to .opencode/knowledge/
  • Copies selected skills to .opencode/skills/
  • Saves configuration for future updates

3. Update Existing Installation

# Update all installed content from warehouse
agentic update

# From a specific warehouse location
agentic update --warehouse /path/to/warehouse

What it does:

  • Reads existing .opencode/.warehouse-config.yml
  • Re-copies all previously selected content
  • Overwrites with latest versions from warehouse

4. Check Installation Status

# Show what's currently installed
agentic status

# For a specific project
agentic status --project /path/to/project

5. Clean Installation

# Remove .opencode directory
agentic clean

# Will prompt for confirmation

Workflow

For Organization Admins

  1. Create warehouse: Fork the template repository

    # Use GitHub's "Use this template" button
    # Name it: your-org-agentic-warehouse
    
  2. Customize content: Add your organization's contexts, knowledge, and skills

    your-org-agentic-warehouse/
    ├── contexts/
    │   ├── AGENTS.global.md
    │   ├── AGENTS.python.md
    │   └── AGENTS.your-domain.md
    ├── knowledge/
    │   ├── global/
    │   ├── languages/python/
    │   └── domains/your-domain/
    └── skills/
        └── your-skill/
    
  3. Distribute to teams: Team members clone and install

For Team Members

  1. Clone warehouse (one time):

    git clone https://github.com/your-org/agentic-warehouse.git ~/agentic-warehouse
    cd ~/agentic-warehouse
    pip install -e libs/agentic_warehouse_cli
    
  2. Setup in project (per project):

    cd ~/your-project
    agentic setup --warehouse ~/agentic-warehouse --interactive
    
  3. Update when needed:

    cd ~/your-project
    agentic update --warehouse ~/agentic-warehouse
    
  4. Add to .gitignore:

    # Add to your project's .gitignore
    .opencode/
    

Directory Structure

Warehouse Structure

your-org-agentic-warehouse/
├── contexts/
│   ├── AGENTS.global.md
│   ├── AGENTS.python.md
│   └── AGENTS.data-platform.md
├── knowledge/
│   ├── global/
│   │   ├── decisions/
│   │   ├── lessons/
│   │   └── facts/
│   ├── languages/
│   │   └── python/
│   └── domains/
│       └── data-platform/
├── skills/
│   └── example-skill/
│       └── SKILL.md
└── libs/
    └── agentic_warehouse_cli/  # This CLI tool

Project Structure (After Setup)

your-project/
├── .opencode/                    # gitignored
│   ├── .warehouse-config.yml    # Tracks what's installed
│   ├── contexts/
│   │   ├── AGENTS.global.md
│   │   └── AGENTS.python.md
│   ├── knowledge/
│   │   ├── global/
│   │   └── languages/
│   │       └── python/
│   └── skills/
│       └── example-skill/
├── .gitignore                    # Contains .opencode/
└── ...

Configuration

The CLI auto-saves configuration to .opencode/.warehouse-config.yml:

contexts:
  - global
  - python
knowledge_scopes:
  - global
  - languages/python
skills:
  - example-skill

This configuration is used by the update command to know what to refresh.

Auto-Detection

The CLI automatically detects:

  • Warehouse root: Looks for directories containing contexts/, knowledge/, and skills/
  • Project root: Looks for .git directory or uses current directory

You can override with --warehouse and --project options.

Examples

Example 1: Setup Python Project

cd ~/my-python-project

# Interactive setup
agentic setup --interactive

# Select:
#   Contexts: global, python
#   Knowledge: global, languages/python
#   Skills: none

# Result: .opencode/ created with selected content

Example 2: Setup Data Platform Project

cd ~/data-platform-project

# Non-interactive setup
agentic setup \
  --context global \
  --context python \
  --context data-platform \
  --knowledge global \
  --knowledge languages/python \
  --knowledge domains/data-platform \
  --skill deploy-airflow

# Result: Full data platform context installed

Example 3: Update After Warehouse Changes

cd ~/my-project

# Warehouse maintainers updated content
# Pull latest warehouse changes
cd ~/agentic-warehouse
git pull origin main

# Update project installation
cd ~/my-project
agentic update

# Result: Latest content synced to .opencode/

Example 4: Check What's Installed

cd ~/my-project
agentic status

# Output:
# Installation: /Users/you/my-project/.opencode
#
# Installed Contexts
# ┌─────────┐
# │ Context │
# ├─────────┤
# │ global  │
# │ python  │
# └─────────┘

Development

Running Tests

cd libs/agentic_warehouse_cli
pytest

Building Package

pip install build
python -m build

Troubleshooting

CLI not found after installation

# Make sure you're in the right environment
which agentic

# Reinstall
pip install -e libs/agentic_warehouse_cli --force-reinstall

Warehouse not auto-detected

# Explicitly specify warehouse path
agentic setup --warehouse /path/to/warehouse

.opencode not in .gitignore

# Add to .gitignore
echo ".opencode/" >> .gitignore

Bundled Skills

Three skills are shipped inside the abc package and available immediately after connecting a warehouse:

Skill Description
record-knowledge Capture decisions, lessons, and facts into the warehouse knowledge base
record-skill Scaffold new Beacon skills with LLM-driven content generation and pending-based wiring
contribute-warehouse Guided contribution flow: lint gate, intent triage, dedup scan, cohesion split, and atomic push

Invoke any bundled skill from an OpenCode or Claude Code session:

/record-knowledge
/record-skill
/contribute-warehouse

Warehouse Commands

Command Description
abc warehouse init [NAME] Initialize a new warehouse
abc warehouse connect --path PATH Connect a project to a warehouse
abc warehouse list [TYPE] List available warehouse artifacts
abc warehouse contribute -m MSG Commit warehouse working-tree changes
abc warehouse status Show warehouse working-tree status
abc warehouse template-upgrade Upgrade warehouse template files
abc warehouse lint [PATH] Validate a warehouse end-to-end (for CI)

abc warehouse lint

Validates a warehouse directory against every Beacon artifact contract: structure, skill frontmatter, skill context references, agent manifest, agent frontmatter (name + description), and knowledge link integrity. Designed as the single entry-point for warehouse-side CI.

# Lint the current directory (inside a warehouse clone)
abc warehouse lint

# Lint a specific path
abc warehouse lint ~/my-org-warehouse

Exit 0 when clean; exit 1 on any finding.

License

MIT

Metadata

Release files for agentic-beacon 3.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agentic-beacon 3.8.0
File Size Uploaded
agentic_beacon-3.8.0.tar.gz 386.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for agentic-beacon 3.8.0
File Interpreter ABI Platform
agentic_beacon-3.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 589.2 kB

Release files / agentic_beacon-3.8.0.tar.gz

Download URL agentic_beacon-3.8.0.tar.gz
Size 386.0 kB
Tags Source
SHA-256 checksum
How to use checksums
38887a90ecb71a833fb73b5dc8c533251ba93b220af54d3f2b2489e0642cd671
BLAKE2b-256 checksum
How to use checksums
b43937e2e3c7b496c38ef262c725021f62eaca9ea6cb94d20cfb846f5a2db717
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.18

Release files / agentic_beacon-3.8.0-py3-none-any.whl

Download URL agentic_beacon-3.8.0-py3-none-any.whl
Size 203.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e5069197bc2077d5b9d69910923c165c04c77825c795010a3a6b9d8da3791aaa
BLAKE2b-256 checksum
How to use checksums
21440d39f66d7d89f127fcfb8ebf3f7b87b92b7c5d35e94d6b95f11a05d39ff2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.18

Release history Release notifications | RSS feed

This release

3.8.0 This release

2 release files

3.7.0

2 release files

3.6.0

2 release files

3.5.1

2 release files

3.5.0

2 release files

3.4.0

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.4

2 release files

2.6.3

2 release files

2.6.2

2 release files

2.6.0

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.6.0

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page