diff --git a/AGENTS.md b/AGENTS.md index 2547086..cdccc87 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ # Contributing Agent Instructions -Instructions for AI agents (Claude Code, Codex, Cursor) contributing to this repo. +Instructions for AI agents (Claude Code, Codex, Cursor, OpenCode) contributing to this repo. ## Repository Structure diff --git a/CLAUDE.md b/CLAUDE.md index d5cf64c..f728670 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -27,3 +27,5 @@ bun run validate # Validate all SKILL.md files - Tests use `bun:test`, test files go in `tests/` - Commit messages follow conventional commits - Bun is the only runtime — do not use npm/yarn/pnpm + +See `README.md` for the full CLI reference, supported agents, and contributing guide. diff --git a/LICENSE b/LICENSE index 7a74473..150eaa4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2025 TxnLab +Copyright (c) 2026 TxnLab Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ec32e95..6d037dc 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,11 @@ Skills are reusable instruction packages that extend AI coding agents (Claude Co npx @txnlab/skills add nfd ``` -That's it. The `nfd` skill is now available to your AI agent. +That's it. The `nfd` skill is now available to your AI agent. If no agent is auto-detected, specify one with `--agent`: + +```bash +npx @txnlab/skills add nfd --agent claude-code +``` ## Available Skills @@ -30,7 +34,7 @@ That's it. The `nfd` skill is now available to your AI agent. | `nfd` | Work with NFDomains, the Algorand Name Service for .algo domains | | `use-wallet` | Integrate Algorand wallet connections with @txnlab/use-wallet | | `haystack-router` | Route and execute optimal swaps on Algorand DEXes via Haystack | -| `skill-creator` | Create new Agent Skills following the Agent Skills specification | +| `skill-creator` | Guide for creating effective Agent Skills following the spec | ## CLI Reference @@ -61,6 +65,8 @@ npx @txnlab/skills add nfd --local # Install to project-level directory ```bash npx @txnlab/skills remove npx @txnlab/skills remove --all +npx @txnlab/skills remove nfd -a claude-code # Target specific agent +npx @txnlab/skills remove nfd --local # Remove from project-level directory ``` ### Validate skills @@ -75,23 +81,27 @@ npx @txnlab/skills validate # Validate one ```bash npx @txnlab/skills dev link # Symlink skill for local dev npx @txnlab/skills dev link --all # Symlink all skills +npx @txnlab/skills dev link nfd --force # Overwrite existing non-symlink target npx @txnlab/skills dev unlink --all # Remove dev symlinks ``` ### Flags -| Flag | Description | -| --------------------- | ------------------------------------------- | -| `-a, --agent ` | Target specific agent (repeatable) | -| `-g, --global` | Install to global skill directory (default) | -| `-l, --local` | Install to project-level skill directory | -| `--all` | Apply to all skills | -| `-y, --yes` | Skip confirmation prompts | -| `-v, --version` | Show version | -| `-h, --help` | Show help | +| Flag | Commands | Description | +| --------------------- | ---------------- | -------------------------------------- | +| `-a, --agent ` | add, remove, dev | Target specific agent (repeatable) | +| `-g, --global` | add, remove | Use global skill directory (default) | +| `-l, --local` | add, remove | Use project-level skill directory | +| `--all` | add, remove, dev | Apply to all skills | +| `--force` | dev link | Overwrite existing non-symlink targets | +| `-y, --yes` | remove | Skip confirmation prompts | +| `-v, --version` | (global) | Show version | +| `-h, --help` | (all) | Show help | ## Installation +Requires Node.js >= 18. + ### Via npx (recommended) ```bash @@ -128,10 +138,10 @@ cd skills # Install dependencies bun install -# Symlink all skills for testing +# Symlink all skills for testing ("bun run dev" runs the CLI from source) bun run dev dev link --all -# Edit skills — changes are picked up by Claude Code immediately +# Edit skills — changes are picked up immediately via symlinks # Validate your work bun run dev validate diff --git a/package.json b/package.json index 6cba007..cf2677e 100644 --- a/package.json +++ b/package.json @@ -24,6 +24,7 @@ "provenance": true }, "license": "MIT", + "homepage": "https://github.com/TxnLab/skills#readme", "repository": { "type": "git", "url": "git+https://github.com/TxnLab/skills.git" diff --git a/skills/skill-creator/SKILL.md b/skills/skill-creator/SKILL.md index 1589797..53447f4 100644 --- a/skills/skill-creator/SKILL.md +++ b/skills/skill-creator/SKILL.md @@ -1,6 +1,6 @@ --- name: skill-creator -description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations. +description: Guide for creating effective Agent Skills following the Agent Skills specification. Use when creating a new skill (or updating an existing skill) that extends an AI coding agent's capabilities with specialized knowledge, workflows, or tool integrations. license: Complete terms in LICENSE.txt ---