agent-ctrl-cli 0.1.0
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.
- package/LICENSE +674 -0
- package/README.md +173 -0
- package/dist/index.js +8871 -0
- package/package.json +59 -0
package/README.md
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# agent-ctrl
|
|
4
|
+
|
|
5
|
+
[](https://bun.sh)
|
|
6
|
+
[](https://www.typescriptlang.org)
|
|
7
|
+
[](https://www.gnu.org/licenses/gpl-3.0)
|
|
8
|
+
[](https://github.com/ahmet-cetinkaya/agent-ctrl/stargazers)
|
|
9
|
+
|
|
10
|
+
A centralized CLI tool for managing AI agent configurations using a **standard directory-based configuration pattern**. Define agent behavior through rules, skills, agents, commands, and MCP servers in a structured, shareable way that works across multiple AI platforms.
|
|
11
|
+
|
|
12
|
+
**Status:** 🚧 Early Development phase.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 🚀 Quick Start
|
|
17
|
+
|
|
18
|
+
### Installation
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# Clone the repository
|
|
22
|
+
git clone https://github.com/ahmet-cetinkaya/agent-ctrl.git
|
|
23
|
+
cd agent-ctrl
|
|
24
|
+
|
|
25
|
+
# Install dependencies
|
|
26
|
+
bun install
|
|
27
|
+
|
|
28
|
+
# Build the CLI
|
|
29
|
+
bun run build
|
|
30
|
+
|
|
31
|
+
# Run directly (development)
|
|
32
|
+
bun run dev --help
|
|
33
|
+
|
|
34
|
+
# Or run the built version
|
|
35
|
+
node dist/index.js --help
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Basic Usage
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# 1. Initialize the global configuration structure (default: ~/.agent-ctrl)
|
|
42
|
+
agent-ctrl init
|
|
43
|
+
|
|
44
|
+
# 2. Search and add a skill from SkillsMP marketplace
|
|
45
|
+
agent-ctrl skill search code-review
|
|
46
|
+
agent-ctrl skill add skillsmp:code-review
|
|
47
|
+
|
|
48
|
+
# 3. Apply your configuration to a supported platform
|
|
49
|
+
agent-ctrl apply claude
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## 🛠Usage & Commands
|
|
55
|
+
|
|
56
|
+
`agent-ctrl` provides a comprehensive suite of commands to manage your AI agent's artifacts.
|
|
57
|
+
|
|
58
|
+
### Global Configuration
|
|
59
|
+
|
|
60
|
+
- `init [path]` - Initialize the global configuration structure (default: `~/.agent-ctrl`).
|
|
61
|
+
- `apply <platform>` - Sync local artifacts to a platform's native configuration.
|
|
62
|
+
|
|
63
|
+
**Supported platforms:**
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Artifact Management
|
|
76
|
+
|
|
77
|
+
#### Rules (`rules/`)
|
|
78
|
+
|
|
79
|
+
Modular behavioral guidelines in Markdown.
|
|
80
|
+
|
|
81
|
+
- `agent-ctrl rule ls` - List all rules.
|
|
82
|
+
|
|
83
|
+
#### Skills (`skills/`)
|
|
84
|
+
|
|
85
|
+
Capabilities following the `SKILL.md` standard.
|
|
86
|
+
|
|
87
|
+
- `agent-ctrl skill ls` - List installed skills.
|
|
88
|
+
- `agent-ctrl skill add <id>` - Install a skill (supports `skillsmp:<id>`).
|
|
89
|
+
- `agent-ctrl skill search <query>` - Search for skills on SkillsMP.
|
|
90
|
+
- `agent-ctrl skill sync` - Synchronize skills catalog.
|
|
91
|
+
- `agent-ctrl skill update <id>` - Update an installed skill.
|
|
92
|
+
- `agent-ctrl skill rm <id>` - Remove a skill.
|
|
93
|
+
|
|
94
|
+
#### Commands (`commands/`)
|
|
95
|
+
|
|
96
|
+
Grouped command prompts or scripts.
|
|
97
|
+
|
|
98
|
+
- `agent-ctrl command ls` - List available commands.
|
|
99
|
+
|
|
100
|
+
#### Agents (`agents/`)
|
|
101
|
+
|
|
102
|
+
Agent personas and identity definitions.
|
|
103
|
+
|
|
104
|
+
- `agent-ctrl agent ls` - List agent personas.
|
|
105
|
+
|
|
106
|
+
#### MCP Configuration (`mcps/`)
|
|
107
|
+
|
|
108
|
+
- `agent-ctrl mcp ls` - List configured MCP servers.
|
|
109
|
+
- `agent-ctrl mcp add <id>` - Add an MCP server (supports `smithery:<id>`).
|
|
110
|
+
- `agent-ctrl mcp search <query>` - Search for MCP servers on Smithery.
|
|
111
|
+
- `agent-ctrl mcp sync` - Synchronize MCP servers catalog.
|
|
112
|
+
- `agent-ctrl mcp update <id>` - Update a configured MCP server.
|
|
113
|
+
- `agent-ctrl mcp rm <id>` - Remove an MCP server.
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## 📂 Project Structure
|
|
118
|
+
|
|
119
|
+
`agent-ctrl` enforces a **Convention over Configuration** pattern. The directory structure IS your agent's configuration.
|
|
120
|
+
|
|
121
|
+
```text
|
|
122
|
+
~/.agent-ctrl/ # Global configuration root (default)
|
|
123
|
+
├── rules/ # Modular behavioral rules (Markdown)
|
|
124
|
+
│ ├── coding-style.md
|
|
125
|
+
│ └── security.md
|
|
126
|
+
├── skills/ # Capabilities (SKILL.md standard)
|
|
127
|
+
│ └── git-workflow/
|
|
128
|
+
│ └── SKILL.md
|
|
129
|
+
├── commands/ # Command prompts (Markdown/Scripts)
|
|
130
|
+
│ ├── dev/
|
|
131
|
+
│ │ └── fix-lint.md
|
|
132
|
+
│ └── explain.md
|
|
133
|
+
├── agents/ # Agent personas
|
|
134
|
+
│ └── architect.md
|
|
135
|
+
├── mcps/ # MCP server configurations
|
|
136
|
+
│ └── filesystem/
|
|
137
|
+
│ └── MCP.json
|
|
138
|
+
└── .env # Optional API credentials for catalog access
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
**Note:** You can also use project-scoped configuration by placing `.agent-ctrl/` in your project directory.
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## 🛠Development
|
|
146
|
+
|
|
147
|
+
**Prerequisites:** [Bun](https://bun.sh) (latest LTS), TypeScript 5.0+
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
# Clone and install
|
|
151
|
+
git clone https://github.com/ahmet-cetinkaya/agent-ctrl.git
|
|
152
|
+
cd agent-ctrl
|
|
153
|
+
bun install
|
|
154
|
+
|
|
155
|
+
# Common tasks
|
|
156
|
+
bun run dev # Run in development mode
|
|
157
|
+
bun run build # Build to dist/
|
|
158
|
+
bun test # Run tests
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
For detailed development workflows, see **[Development](./docs/DEVELOPMENT.md)**.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## 📚 Documentation
|
|
166
|
+
|
|
167
|
+
For detailed documentation, see **[docs/README.md](./docs/README.md)**.
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
## 📄 License
|
|
172
|
+
|
|
173
|
+
This project is licensed under the **GNU General Public License v3.0** - see the [LICENSE](LICENSE) file for details.
|