@kendoo.agentdesk/agentdesk 0.1.0 → 0.1.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 +120 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,120 @@
1
+ # AgentDesk
2
+
3
+ AI team orchestrator for [Claude Code](https://claude.ai/claude-code). Run collaborative agent sessions from your terminal and watch them live on [agentdesk.live](https://agentdesk.live).
4
+
5
+ AgentDesk spawns a team of 7 specialized AI agents that collaborate on your tasks:
6
+
7
+ | Agent | Role |
8
+ |-------|------|
9
+ | Jane | Product Lead — facilitates, clarifies requirements, coordinates the team |
10
+ | Luna | UX/UI Designer — visual consistency, accessibility, interaction patterns |
11
+ | Mark | Content Writer — copy, tone, user-facing text |
12
+ | Sam | Architecture Auditor — code structure, separation of concerns |
13
+ | Dennis | Senior Developer — implements the solution |
14
+ | Bart | QA Engineer — edge cases, risks, acceptance criteria |
15
+ | Vera | Test Engineer — unit tests, regression coverage |
16
+
17
+ ## Getting Started
18
+
19
+ ### 1. Install
20
+
21
+ ```bash
22
+ npm i -g @kendoo.agentdesk/agentdesk
23
+ ```
24
+
25
+ Requires [Node.js](https://nodejs.org/) 18+ and [Claude Code](https://claude.ai/claude-code) installed.
26
+
27
+ ### 2. Create an account
28
+
29
+ Sign up at [agentdesk.live](https://agentdesk.live) and copy your API key from **Settings**.
30
+
31
+ ### 3. Configure your project
32
+
33
+ Add your API key to your project's `.env` file:
34
+
35
+ ```bash
36
+ cd your-project
37
+ echo "AGENTDESK_API_KEY=your-key-here" >> .env
38
+ ```
39
+
40
+ Run init to verify the setup:
41
+
42
+ ```bash
43
+ agentdesk init
44
+ ```
45
+
46
+ ### 4. Run a team session
47
+
48
+ ```bash
49
+ agentdesk team KEN-517
50
+ agentdesk team BUG-42 -d "Fix the checkout total calculation"
51
+ ```
52
+
53
+ Open [agentdesk.live](https://agentdesk.live) to watch the session live.
54
+
55
+ ## Configuration
56
+
57
+ Create `.agentdesk.json` in your project root to customize behavior:
58
+
59
+ ```json
60
+ {
61
+ "tracker": "linear",
62
+ "linear": { "workspace": "your-workspace" }
63
+ }
64
+ ```
65
+
66
+ ### Task trackers
67
+
68
+ | Tracker | Config |
69
+ |---------|--------|
70
+ | Linear | `{ "tracker": "linear", "linear": { "workspace": "..." } }` |
71
+ | Jira | `{ "tracker": "jira", "jira": { "baseUrl": "https://yourcompany.atlassian.net" } }` |
72
+ | GitHub Issues | `{ "tracker": "github", "github": { "repo": "owner/repo" } }` |
73
+
74
+ ### Declaring project agents
75
+
76
+ If your project has existing AI agents, bots, or automation, declare them so the team knows about them:
77
+
78
+ ```json
79
+ {
80
+ "projectAgents": [
81
+ {
82
+ "name": "ReviewBot",
83
+ "role": "Auto-reviews PRs for security issues",
84
+ "when": "Triggers on every PR creation",
85
+ "how": "Comment /review on a PR to re-trigger"
86
+ }
87
+ ]
88
+ }
89
+ ```
90
+
91
+ AgentDesk also auto-discovers agents from `.claude/agents/`, `.claude/commands/`, `.mcp.json`, GitHub Actions workflows, Dependabot, and Renovate configs.
92
+
93
+ ## Usage
94
+
95
+ ```
96
+ agentdesk init Detect project and show setup info
97
+ agentdesk team <TASK-ID> Run a team session on a task
98
+ agentdesk team <TASK-ID> -d "..." Run with a task description
99
+ ```
100
+
101
+ ### Options
102
+
103
+ | Flag | Description |
104
+ |------|-------------|
105
+ | `--description`, `-d` | Task description (for projects without a task tracker) |
106
+ | `--cwd` | Working directory (defaults to current) |
107
+
108
+ ## How It Works
109
+
110
+ 1. You run `agentdesk team TASK-ID` in your project directory
111
+ 2. AgentDesk detects your project type, reads `CLAUDE.md`, and discovers existing agents
112
+ 3. A Claude Code session starts with all 7 agents collaborating on your task
113
+ 4. The team goes through structured phases: **Brainstorm** > **Planning** > **Execution** > **Review**
114
+ 5. The session streams live to [agentdesk.live](https://agentdesk.live) where you can watch and send messages to the team
115
+
116
+ ## Requirements
117
+
118
+ - [Node.js](https://nodejs.org/) 18+
119
+ - [Claude Code](https://claude.ai/claude-code) CLI installed and authenticated
120
+ - An AgentDesk account at [agentdesk.live](https://agentdesk.live)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kendoo.agentdesk/agentdesk",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "AI team orchestrator for Claude Code — run collaborative agent sessions from your terminal",
5
5
  "type": "module",
6
6
  "bin": {
@@ -9,7 +9,8 @@
9
9
  "files": [
10
10
  "bin/",
11
11
  "cli/",
12
- "prompts/"
12
+ "prompts/",
13
+ "README.md"
13
14
  ],
14
15
  "engines": {
15
16
  "node": ">=18"