stacksagent 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +182 -0
  2. package/package.json +4 -4
package/README.md ADDED
@@ -0,0 +1,182 @@
1
+ # stacksagent
2
+
3
+ > AI Skill CLI installer for building Stacks blockchain applications
4
+
5
+ [![npm version](https://img.shields.io/npm/v/stacksagent.svg)](https://www.npmjs.com/package/stacksagent)
6
+ [![npm downloads](https://img.shields.io/npm/dm/stacksagent.svg)](https://www.npmjs.com/package/stacksagent)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+
9
+ Transform your AI coding assistant into a Stacks blockchain expert with 170+ searchable knowledge entries.
10
+
11
+ ## 🎯 Supported AI Platforms
12
+
13
+ - **Claude Code** - Claude's official CLI
14
+ - **Cursor** - AI-first code editor
15
+ - **Windsurf** - AI coding assistant
16
+ - **Antigravity** - AI development tool
17
+ - **GitHub Copilot** - GitHub's AI assistant
18
+ - **Kiro** - AI coding helper
19
+ - **Codex** - OpenAI Codex integration
20
+
21
+ ## 📦 Installation
22
+
23
+ ```bash
24
+ npm install -g stacksagent
25
+ ```
26
+
27
+ ## 🚀 Usage
28
+
29
+ ### Install for Your AI Platform
30
+
31
+ ```bash
32
+ # Claude Code
33
+ stacksagent init --ai claude
34
+
35
+ # Cursor
36
+ stacksagent init --ai cursor
37
+
38
+ # Windsurf
39
+ stacksagent init --ai windsurf
40
+
41
+ # Antigravity
42
+ stacksagent init --ai antigravity
43
+
44
+ # GitHub Copilot
45
+ stacksagent init --ai copilot
46
+
47
+ # Kiro
48
+ stacksagent init --ai kiro
49
+
50
+ # Codex
51
+ stacksagent init --ai codex
52
+
53
+ # All platforms at once
54
+ stacksagent init --ai all
55
+ ```
56
+
57
+ ### Force Overwrite
58
+
59
+ ```bash
60
+ stacksagent init --ai claude --force
61
+ ```
62
+
63
+ ### Check Version
64
+
65
+ ```bash
66
+ stacksagent --version
67
+ ```
68
+
69
+ ### Update to Latest
70
+
71
+ ```bash
72
+ stacksagent update
73
+ ```
74
+
75
+ ### List Available Versions
76
+
77
+ ```bash
78
+ stacksagent versions
79
+ ```
80
+
81
+ ## 💡 What Gets Installed
82
+
83
+ The CLI installs platform-specific skill files in your project:
84
+
85
+ - **Claude Code**: `.claude/skills/stacks-agent/`
86
+ - **Cursor**: `.cursor/commands/` + `.shared/stacks-agent/`
87
+ - **Windsurf**: `.windsurf/workflows/` + `.shared/stacks-agent/`
88
+ - **Antigravity**: `.agent/workflows/` + `.shared/stacks-agent/`
89
+ - **Copilot**: `.github/prompts/` + `.shared/stacks-agent/`
90
+ - **Kiro**: `.kiro/steering/` + `.shared/stacks-agent/`
91
+ - **Codex**: `.codex/skills/stacks-agent/`
92
+
93
+ ## 📚 Knowledge Base
94
+
95
+ 170+ entries across 8 domains:
96
+
97
+ - **Clarity** (61) - Language syntax and functions
98
+ - **Templates** (14) - Contract templates (SIP-010, SIP-009, DAO, Vault)
99
+ - **Security** (15) - Vulnerability patterns and fixes
100
+ - **DeFi** (15) - Protocol integrations (Alex, Velar, Bitflow, Zest)
101
+ - **Stacks.js** (30) - Frontend integration snippets
102
+ - **BNS** (10) - Bitcoin Name System operations
103
+ - **Stacking** (15) - PoX stacking guides
104
+ - **Deployment** (25) - Testnet/mainnet deployment steps
105
+
106
+ ## 🔍 Search Knowledge Base
107
+
108
+ After installation, search the knowledge base:
109
+
110
+ ```bash
111
+ python3 .claude/skills/stacks-agent/scripts/search.py "your query"
112
+
113
+ # Search specific domain
114
+ python3 .claude/skills/stacks-agent/scripts/search.py "swap tokens" --domain defi
115
+
116
+ # Get more results
117
+ python3 .claude/skills/stacks-agent/scripts/search.py "security" -n 10
118
+
119
+ # JSON output
120
+ python3 .claude/skills/stacks-agent/scripts/search.py "stx transfer" -f json
121
+ ```
122
+
123
+ ## 💬 Example Prompts
124
+
125
+ After installing the skill, ask your AI assistant:
126
+
127
+ - "Create a SIP-010 token with burn mechanism"
128
+ - "Build an NFT collection with royalties"
129
+ - "Audit this Clarity contract for security issues"
130
+ - "Show me how to integrate Alex swap"
131
+ - "Deploy my contract to testnet"
132
+ - "How do I implement stacking?"
133
+
134
+ ## 🛠️ Development
135
+
136
+ ### Requirements
137
+
138
+ - Node.js 18+
139
+ - Python 3.x (for search functionality)
140
+
141
+ ### Build from Source
142
+
143
+ ```bash
144
+ git clone https://github.com/kai-builder/stacksagent.git
145
+ cd stacksagent/cli
146
+ npm install
147
+ npm run build
148
+ npm link
149
+ ```
150
+
151
+ ## 📖 Documentation
152
+
153
+ - [Main Repository](https://github.com/kai-builder/stacksagent)
154
+ - [Stacks Docs](https://docs.stacks.co)
155
+ - [Clarity Reference](https://docs.stacks.co/clarity)
156
+ - [Hiro Platform](https://platform.hiro.so)
157
+
158
+ ## 🤝 Contributing
159
+
160
+ Contributions welcome! Please see [Contributing Guide](https://github.com/kai-builder/stacksagent/blob/main/CONTRIBUTING.md).
161
+
162
+ ## 📄 License
163
+
164
+ MIT License - see [LICENSE](LICENSE) for details.
165
+
166
+ ## 🙏 Credits
167
+
168
+ Built for the Stacks community with:
169
+ - [Stacks.js](https://github.com/hirosystems/stacks.js)
170
+ - [Stacks Blockchain](https://www.stacks.co)
171
+ - [Clarity Language](https://docs.stacks.co/clarity)
172
+
173
+ ## 📞 Support
174
+
175
+ - **GitHub Issues**: [Report bugs or request features](https://github.com/kai-builder/stacksagent/issues)
176
+ - **Stacks Discord**: [Join the community](https://discord.gg/stacks)
177
+
178
+ ---
179
+
180
+ **Made with ❤️ for the Stacks community**
181
+
182
+ *Build Bitcoin-secured dApps with AI assistance*
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stacksagent",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "AI Skill for building Stacks blockchain applications - CLI installer",
5
5
  "bin": {
6
6
  "stacksagent": "./dist/index.js"
@@ -36,12 +36,12 @@
36
36
  },
37
37
  "repository": {
38
38
  "type": "git",
39
- "url": "git+https://github.com/kai-builder/stacks-agent.git"
39
+ "url": "git+https://github.com/kai-builder/stacksagent.git"
40
40
  },
41
41
  "bugs": {
42
- "url": "https://github.com/kai-builder/stacks-agent/issues"
42
+ "url": "https://github.com/kai-builder/stacksagent/issues"
43
43
  },
44
- "homepage": "https://github.com/kai-builder/stacks-agent#readme",
44
+ "homepage": "https://github.com/kai-builder/stacksagent#readme",
45
45
  "dependencies": {
46
46
  "commander": "^11.0.0",
47
47
  "fs-extra": "^11.0.0",