diff --git a/README.md b/README.md index f6cfe951..fc98ef28 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ - [๐Ÿš€ New Here? Start Here!](#new-here-start-here) - [๐Ÿ“– Complete Usage Guide](docs/users/usage.md) - **Start here if confused after installation!** -- [๐Ÿ”Œ Compatibility & Invocation](#compatibility--invocation) +- [๐Ÿ”Œ Compatibility & Invocation](#compatibility--invocation) - [๐Ÿ› ๏ธ Installation](#installation) - [๐Ÿ›ก๏ธ Security Posture](#security-posture) - [๐Ÿงฏ Troubleshooting](#troubleshooting) @@ -37,7 +37,7 @@ - [๐Ÿค Contributing](#contributing) - [๐Ÿ’ฌ Community](#community) - [โ˜• Support the Project](#support-the-project) -- [๐Ÿ† Credits & Sources](#credits--sources) +- [๐Ÿ† Credits & Sources](#credits--sources) - [๐Ÿ‘ฅ Repo Contributors](#repo-contributors) - [โš–๏ธ License](#license) - [๐ŸŒŸ Star History](#star-history) @@ -65,18 +65,17 @@ Install once; then use Starter Packs in [docs/users/bundles.md](docs/users/bundl # Default: ~/.gemini/antigravity/skills (Antigravity global). Use --path for other locations. npx antigravity-awesome-skills ``` - 2. **Verify**: ```bash test -d ~/.gemini/antigravity/skills && echo "Skills installed in ~/.gemini/antigravity/skills" ``` - 3. **Run your first skill**: > "Use **@brainstorming** to plan a SaaS MVP." - + > 4. **Pick a bundle**: + - **Web Dev?** start with `Web Wizard`. - **Security?** start with `Security Engineer`. - **General use?** start with `Essentials`. @@ -98,18 +97,18 @@ Once installed, just ask your agent naturally: These skills follow the universal **SKILL.md** format and work with any AI coding assistant that supports agentic skills. -| Tool | Type | Invocation Example | Path | -| :-------------- | :--- | :-------------------------------- | :-------------------------------------------------------------------- | -| **Claude Code** | CLI | `>> /skill-name help me...` | `.claude/skills/` | -| **Gemini CLI** | CLI | `(User Prompt) Use skill-name...` | `.gemini/skills/` | -| **Codex CLI** | CLI | `(User Prompt) Use skill-name...` | `.codex/skills/` | -| **Kiro CLI** | CLI | `(Auto) Skills load on-demand` | Global: `~/.kiro/skills/` ยท Workspace: `.kiro/skills/` | -| **Kiro IDE** | IDE | `/skill-name or (Auto)` | Global: `~/.kiro/skills/` ยท Workspace: `.kiro/skills/` | -| **Antigravity** | IDE | `(Agent Mode) Use skill...` | Global: `~/.gemini/antigravity/skills/` ยท Workspace: `.agent/skills/` | -| **Cursor** | IDE | `@skill-name (in Chat)` | `.cursor/skills/` | -| **Copilot** | Ext | `(Paste content manually)` | N/A | -| **OpenCode** | CLI | `opencode run @skill-name` | `.agents/skills/` | -| **AdaL CLI** | CLI | `(Auto) Skills load on-demand` | `.adal/skills/` | +| Tool | Type | Invocation Example | Path | +| :-------------------- | :--- | :---------------------------------- | :------------------------------------------------------------------------ | +| **Claude Code** | CLI | `>> /skill-name help me...` | `.claude/skills/` | +| **Gemini CLI** | CLI | `(User Prompt) Use skill-name...` | `.gemini/skills/` | +| **Codex CLI** | CLI | `(User Prompt) Use skill-name...` | `.codex/skills/` | +| **Kiro CLI** | CLI | `(Auto) Skills load on-demand` | Global:`~/.kiro/skills/` ยท Workspace: `.kiro/skills/` | +| **Kiro IDE** | IDE | `/skill-name or (Auto)` | Global:`~/.kiro/skills/` ยท Workspace: `.kiro/skills/` | +| **Antigravity** | IDE | `(Agent Mode) Use skill...` | Global:`~/.gemini/antigravity/skills/` ยท Workspace: `.agent/skills/` | +| **Cursor** | IDE | `@skill-name (in Chat)` | `.cursor/skills/` | +| **Copilot** | Ext | `(Paste content manually)` | N/A | +| **OpenCode** | CLI | `opencode run @skill-name` | `.agents/skills/` | +| **AdaL CLI** | CLI | `(Auto) Skills load on-demand` | `.adal/skills/` | > [!TIP] > **Default installer path**: `~/.gemini/antigravity/skills` (Antigravity global). Use `--path ~/.agent/skills` for workspace-specific install. For manual clone, `.agent/skills/` works as workspace path for Antigravity. @@ -155,19 +154,19 @@ This installs the same repository-backed skill library through Claude Code's plu ## Choose Your Tool -| Tool | Install | First Use | -| -------------- | ------------------------------------------------------ | ---------------------------------------------------- | -| Claude Code | `npx antigravity-awesome-skills --claude` or Claude plugin marketplace | `>> /brainstorming help me plan a feature` | -| Cursor | `npx antigravity-awesome-skills --cursor` | `@brainstorming help me plan a feature` | -| Gemini CLI | `npx antigravity-awesome-skills --gemini` | `Use brainstorming to plan a feature` | -| Codex CLI | `npx antigravity-awesome-skills --codex` | `Use brainstorming to plan a feature` | -| Antigravity | `npx antigravity-awesome-skills --antigravity` | `Use @brainstorming to plan a feature` | -| Kiro CLI | `npx antigravity-awesome-skills --kiro` | `Use brainstorming to plan a feature` | -| Kiro IDE | `npx antigravity-awesome-skills --path ~/.kiro/skills` | `Use @brainstorming to plan a feature` | -| GitHub Copilot | _No installer โ€” paste skills or rules manually_ | `Ask Copilot to use brainstorming to plan a feature` | -| OpenCode | `npx antigravity-awesome-skills --path .agents/skills` | `opencode run @brainstorming help me plan a feature` | -| AdaL CLI | `npx antigravity-awesome-skills --path .adal/skills` | `Use brainstorming to plan a feature` | -| Custom path | `npx antigravity-awesome-skills --path ./my-skills` | Depends on your tool | +| Tool | Install | First Use | +| -------------- | ------------------------------------------------------------------------ | ------------------------------------------------------ | +| Claude Code | `npx antigravity-awesome-skills --claude` or Claude plugin marketplace | `>> /brainstorming help me plan a feature` | +| Cursor | `npx antigravity-awesome-skills --cursor` | `@brainstorming help me plan a feature` | +| Gemini CLI | `npx antigravity-awesome-skills --gemini` | `Use brainstorming to plan a feature` | +| Codex CLI | `npx antigravity-awesome-skills --codex` | `Use brainstorming to plan a feature` | +| Antigravity | `npx antigravity-awesome-skills --antigravity` | `Use @brainstorming to plan a feature` | +| Kiro CLI | `npx antigravity-awesome-skills --kiro` | `Use brainstorming to plan a feature` | +| Kiro IDE | `npx antigravity-awesome-skills --path ~/.kiro/skills` | `Use @brainstorming to plan a feature` | +| GitHub Copilot | _No installer โ€” paste skills or rules manually_ | `Ask Copilot to use brainstorming to plan a feature` | +| OpenCode | `npx antigravity-awesome-skills --path .agents/skills` | `opencode run @brainstorming help me plan a feature` | +| AdaL CLI | `npx antigravity-awesome-skills --path .adal/skills` | `Use brainstorming to plan a feature` | +| Custom path | `npx antigravity-awesome-skills --path ./my-skills` | Depends on your tool | ## Security Posture @@ -193,8 +192,8 @@ These skills are continuously reviewed and hardened, but the collection is not " ## Project Structure -| Path | Purpose | -| -------------------- | --------------------------------------------------------- | +| Path | Purpose | +| ---------------------- | --------------------------------------------------------- | | `skills/` | The canonical skill library | | `docs/users/` | Getting started, usage, bundles, workflows, visual guides | | `docs/contributors/` | Templates, anatomy, examples, quality bar, community docs | @@ -290,8 +289,8 @@ Initial workflows include: The repository is organized into specialized domains to transform your AI into an expert across the entire software development lifecycle: -| Category | Focus | Example skills | -| :------------- | :------------------------------------------------- | :------------------------------------------------------------------------------ | +| Category | Focus | Example skills | +| :------------- | :------------------------------------------------- | :------------------------------------------------------------------------------------ | | Architecture | System design, ADRs, C4, and scalable patterns | `architecture`, `c4-context`, `senior-architect` | | Business | Growth, pricing, CRO, SEO, and go-to-market | `copywriting`, `pricing-strategy`, `seo-audit` | | Data & AI | LLM apps, RAG, agents, observability, analytics | `rag-engineer`, `prompt-engineer`, `langgraph` | @@ -314,11 +313,11 @@ Counts change as new skills are added. For the current full registry, see [CATAL ## Documentation -| For Users | For Contributors | For Maintainers | -| ---------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| [`docs/users/getting-started.md`](docs/users/getting-started.md) | [`CONTRIBUTING.md`](CONTRIBUTING.md) | [`docs/maintainers/release-process.md`](docs/maintainers/release-process.md) | -| [`docs/users/usage.md`](docs/users/usage.md) | [`docs/contributors/skill-anatomy.md`](docs/contributors/skill-anatomy.md) | [`docs/maintainers/audit.md`](docs/maintainers/audit.md) | -| [`docs/users/faq.md`](docs/users/faq.md) | [`docs/contributors/quality-bar.md`](docs/contributors/quality-bar.md) | [`docs/maintainers/ci-drift-fix.md`](docs/maintainers/ci-drift-fix.md) | +| For Users | For Contributors | For Maintainers | +| --------------------------------------------------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| [`docs/users/getting-started.md`](docs/users/getting-started.md) | [`CONTRIBUTING.md`](CONTRIBUTING.md) | [`docs/maintainers/release-process.md`](docs/maintainers/release-process.md) | +| [`docs/users/usage.md`](docs/users/usage.md) | [`docs/contributors/skill-anatomy.md`](docs/contributors/skill-anatomy.md) | [`docs/maintainers/audit.md`](docs/maintainers/audit.md) | +| [`docs/users/faq.md`](docs/users/faq.md) | [`docs/contributors/quality-bar.md`](docs/contributors/quality-bar.md) | [`docs/maintainers/ci-drift-fix.md`](docs/maintainers/ci-drift-fix.md) | | [`docs/users/visual-guide.md`](docs/users/visual-guide.md) | [`docs/contributors/examples.md`](docs/contributors/examples.md) | [`docs/maintainers/skills-update-guide.md`](docs/maintainers/skills-update-guide.md) ยท [`.github/MAINTENANCE.md`](.github/MAINTENANCE.md) | ## Troubleshooting @@ -349,10 +348,19 @@ That guide includes: If your agent is struggling with context window limits due to too many loaded skills, use the activation script. It keeps the full library in a separate archive folder and only activates the bundles or skills you need into the live Antigravity skills directory. -Windows example from the repository root: +**Important Usage Instructions:** + +1. **First, manually close the repository** (e.g., exit your AI agent or close your IDE). +2. Open a terminal inside the folder where you cloned this repository (NOTE: repository has to be cloned). +3. Run the script located in the `scripts` folder. + +Windows examples: ```bat +:: Activate specific bundles .\scripts\activate-skills.bat "Web Wizard" "Integration & APIs" + +:: Clear and reset (removes all skills except the Essentials bundle) .\scripts\activate-skills.bat --clear ``` diff --git a/tools/scripts/get-bundle-skills.py b/tools/scripts/get-bundle-skills.py index 3fd21214..2906c5aa 100644 --- a/tools/scripts/get-bundle-skills.py +++ b/tools/scripts/get-bundle-skills.py @@ -18,6 +18,7 @@ def format_skills_for_batch(skill_ids): safe_skill_ids = filter_safe_skill_ids(skill_ids) if not safe_skill_ids: return "" + # Use newline separator for robustness (avoiding Windows command line length limits) return "\n".join(safe_skill_ids) + "\n" @@ -26,6 +27,7 @@ def get_bundle_skills(bundle_queries, bundles_path=None): bundles_path = Path(__file__).parent.parent.parent / "docs" / "users" / "bundles.md" else: bundles_path = Path(bundles_path) + if not bundles_path.exists(): print(f"Error: {bundles_path} not found", file=sys.stderr) return [] @@ -56,6 +58,7 @@ def get_bundle_skills(bundle_queries, bundles_path=None): return sorted(list(selected_skills)) + if __name__ == "__main__": if len(sys.argv) < 2: # Default to Essentials if no query