Skip to main content

The premier agentic skills library for professional AI engineering

Project description

skillsmith Documentation

PyPI version License: MIT

skillsmith helps you prepare a project so AI coding tools can understand your project better and work more reliably.

This guide is written for beginners. You can copy and run commands as shown.

1) Install

pip install skillsmith

Optional MCP support:

pip install "skillsmith[mcp]"

If skillsmith is not found, use module mode:

python -m skillsmith --help

2) 60-Second Start

Run this inside your project folder:

skillsmith init --guided

Then do:

skillsmith recommend
skillsmith add <skill-name>
skillsmith sync
skillsmith align
skillsmith audit --strict

3) What You Get

After setup, skillsmith creates and manages:

  • .agent/ project context and memory files
  • AI-tool instruction files (for supported tools)
  • skill installation and tracking (skills.lock.json)
  • workflow/evaluation/trust utilities

Context Tiers

skillsmith keeps context in simple layers:

  • Tier 1: the active task and recent instructions
  • Tier 2: project state in .agent/project_profile.yaml and .agent/context/project-context.md
  • Tier 3: retrieval and memory artifacts in .agent/context/index.json, .agent/context/query_policy.json, and .agent/snapshots/

skillsmith context-index build writes the retrieval index, skillsmith context-index query returns ranked matches with score breakdowns, and skillsmith snapshot saves or restores the .agent/ folder. Snapshot notes, when provided, are stored beside the archive in .agent/snapshots/ as .note.txt files and are the place to keep short memory lessons or handoff notes.

4) Command Reference (Simple)

Project Setup

  • skillsmith init: Create the skillsmith workspace in your project.
  • skillsmith sync: Re-scan your project and refresh generated files.
  • skillsmith align: Re-render managed files from your saved profile.
  • skillsmith doctor: Health check for setup and environment.
  • skillsmith audit: Full quality/trust/drift audit.
  • skillsmith report: Human-readable project status summary.
  • skillsmith profile: View or change project profile settings.

Skills

  • skillsmith list: Show available skills.
  • skillsmith discover <query>: Search for skills by keyword.
  • skillsmith recommend: Suggest skills based on your project.
  • skillsmith add <skill-name-or-url>: Install one skill.
  • skillsmith update: Update installed local skills.
  • skillsmith lint: Validate skill metadata and structure.
  • skillsmith rebuild: Rebuild local catalog from skill files.
  • skillsmith assets status: Show optional runtime asset availability.
  • skillsmith assets bootstrap: Download/copy runtime assets into local cache.

Workflow and Evaluation

  • skillsmith compose "<goal>": Generate a step-by-step workflow for a goal.
  • skillsmith autonomous run: Start the autonomous workflow loop.
  • skillsmith autonomous status: Show the current autonomous workflow state.
  • skillsmith autonomous report: Generate an autonomous workflow summary.
  • skillsmith eval: Run evaluation and save metrics artifact.
  • skillsmith budget: Show context/token budget usage.
  • skillsmith context-index build: Build searchable project context index.
  • skillsmith context-index query "<query>": Search ranked project context.
  • skillsmith context ...: Alias for context-index.

Autonomous Contract

The 8-pillar autonomy contract in this release is:

  1. Bounded domain: autonomous runs currently support recommendation workflows only.
  2. Benchmark-driven: runs load a benchmark pack from .agent/autonomy/benchmarks/.
  3. Preflight safety: runs stop early if git is missing, the repo is not clean, or preflight fails.
  4. Bounded execution: --max-hours, --max-iterations, and --early-stop-fails cap loop length.
  5. Score gating: --score-gate and --strict-gate control keep/discard/crash behavior.
  6. Session persistence: each run writes session JSON, state JSON, and a latest pointer.
  7. Audit trail: results.tsv records preflight, iteration, and summary rows for each session.
  8. Status/report access: status and report resolve the latest session from .agent/autonomy/latest.json.

Artifacts and paths:

  • .agent/autonomy/runs/<session-id>/session.json
  • .agent/autonomy/runs/<session-id>/state.json
  • .agent/autonomy/runs/<session-id>/iterations/
  • .agent/autonomy/latest.json
  • .agent/autonomy/results.tsv
  • .agent/autonomy/benchmarks/

Safety behavior:

  • Dirty git trees are blocked before execution starts.
  • Strict gate failures end the run with a crash result.
  • Missing or invalid latest-session data falls back to "no autonomy session found" instead of raising.

Registry and Trust (Advanced / Team Use)

  • skillsmith registry: Manage team registry entries/lifecycle.
  • skillsmith registry-service: Run/sync local registry service API.
  • skillsmith trust-service: Run/sync local trust service API.

MCP Server and Context Snapshots

  • skillsmith serve: Start MCP server for tool integrations.
  • skillsmith snapshot: Save/restore .agent context snapshots.
  • skillsmith watch: Monitor context drift and staleness.

Maintenance

  • skillsmith update: Update installed skills.

5) Beginner-Friendly Workflows

A) First time in a project

skillsmith init --guided
skillsmith recommend
skillsmith add <skill-name>
skillsmith audit

B) Before starting a new task

skillsmith sync
skillsmith align
skillsmith compose "build <your-goal>"

C) Before merge/release

skillsmith eval
skillsmith audit --strict
skillsmith report

6) Most Useful Help Commands

Show global help:

skillsmith --help

Show help for one command:

skillsmith <command> --help

Examples:

skillsmith init --help
skillsmith audit --help
skillsmith registry-service --help

7) Library vs CLI

skillsmith is a Python package, but the supported public interface is the CLI.

  • Stable: skillsmith <command> and python -m skillsmith <command>
  • Not guaranteed stable: importing internal modules like skillsmith.commands.*

8) Development

Run from source:

PYTHONPATH=src python -m skillsmith --help

Build package artifacts:

uv run --group dev python -m build

9) Current Version

  • Package version: 0.6.5

License

MIT. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skillsmith-0.6.6.tar.gz (196.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skillsmith-0.6.6-py3-none-any.whl (224.2 kB view details)

Uploaded Python 3

File details

Details for the file skillsmith-0.6.6.tar.gz.

File metadata

  • Download URL: skillsmith-0.6.6.tar.gz
  • Upload date:
  • Size: 196.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for skillsmith-0.6.6.tar.gz
Algorithm Hash digest
SHA256 30b93405f83cd353adc52b89f89ca6939064f73bf51319aea39484c35ff8376b
MD5 99ac4788feaee8c22f780584f395e2aa
BLAKE2b-256 d1714d08286bdb598cd1b2aa0083bdd50d9e62ed22ca80b24fa349f669dd0b9c

See more details on using hashes here.

File details

Details for the file skillsmith-0.6.6-py3-none-any.whl.

File metadata

  • Download URL: skillsmith-0.6.6-py3-none-any.whl
  • Upload date:
  • Size: 224.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for skillsmith-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b9558a2e98cb2b504acb4a7b8183a49fad381b748915a3724a0d273aa694b955
MD5 678327667fddeabdeac1159a075254a1
BLAKE2b-256 b4be7d428d0640fa28ff1ffc3422158077fcc0ebaff4a535280a101c71002399

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page