Agentic Beacon CLI - Distribute knowledge contexts and skills for AI-assisted development teams
Project description
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
.opencodefolders in projects - Easy updates: Sync latest changes from the warehouse with one command
Installation
Recommended: Install with uv (if you have uv installed)
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
-
Create warehouse: Fork the template repository
# Use GitHub's "Use this template" button # Name it: your-org-agentic-warehouse
-
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/ -
Distribute to teams: Team members clone and install
For Team Members
-
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
-
Setup in project (per project):
cd ~/your-project agentic setup --warehouse ~/agentic-warehouse --interactive
-
Update when needed:
cd ~/your-project agentic update --warehouse ~/agentic-warehouse
-
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/, andskills/ - Project root: Looks for
.gitdirectory 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agentic_beacon-3.7.0.tar.gz.
File metadata
- Download URL: agentic_beacon-3.7.0.tar.gz
- Upload date:
- Size: 369.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7abf8734fc78b5d078b5e78322360c10f3dc135b2b71635d0bb7637c52e52232
|
|
| MD5 |
7c8badd0e1b04fa953f35a60b2b9023f
|
|
| BLAKE2b-256 |
83620cf3a906a20d45a5ba4124cf51b1c6ba872d089f5805683e82eb132cd8ce
|
File details
Details for the file agentic_beacon-3.7.0-py3-none-any.whl.
File metadata
- Download URL: agentic_beacon-3.7.0-py3-none-any.whl
- Upload date:
- Size: 198.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e85cd1f371581d57689883c5d786c2f1c89cd127916affea9542140712b586c0
|
|
| MD5 |
90eefbb8268097d0fee1ecdf63e5c28f
|
|
| BLAKE2b-256 |
28c8b8675f901745a498b8d5187d576b164cc115e03b2b9801217ce79ae57a1d
|