@task-shepherd/agent 1.0.14 → 1.0.17

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.md ADDED
@@ -0,0 +1,21 @@
1
+ # Task Shepherd Proprietary License
2
+
3
+ Copyright (c) 2025 Task Shepherd LLC
4
+
5
+ ## Commercial Use License
6
+
7
+ ### Permitted Uses
8
+ ✅ Use in commercial/business environments
9
+ ✅ Deploy in production systems
10
+ ✅ Internal business operations
11
+ ✅ Integration with existing systems
12
+
13
+ ### Prohibited Uses
14
+ ❌ Modification of source code
15
+ ❌ Redistribution or resale
16
+ ❌ Creating derivative works
17
+ ❌ Reverse engineering
18
+ ❌ Sublicensing
19
+
20
+ ### Terms
21
+ This software is provided "as-is" without warranty. The copyright holder retains all rights not explicitly granted above.
package/README.md CHANGED
@@ -15,14 +15,35 @@ npm install -g @task-shepherd/agent
15
15
  task-shepherd-agent init
16
16
  ```
17
17
 
18
- ### 2. Configure API Connection
18
+ This interactive wizard will guide you through:
19
+ - Configuring your Task Shepherd organization connection
20
+ - Setting up your Claude API key
21
+ - Selecting your agent identity strategy
22
+ - Configuring ports and service settings
23
+ - Setting agent capabilities
24
+
25
+ **Before running init, you'll need:**
26
+ - **Organization ID**: From your Task Shepherd organization settings
27
+ - **API URL**: Your organization's GraphQL endpoint (e.g., `https://your-org.api.taskshepherd.com/graphql`)
28
+ - **API Key**: Generated from Task Shepherd dashboard → Settings → API Keys
29
+ - **Claude API Key**: From Anthropic Console → API Keys (starts with `sk-ant-api03-`)
30
+
31
+ ### 2. Register Workspaces
32
+
33
+ After initialization, register the projects you want the agent to work on:
34
+
19
35
  ```bash
20
- # Set your Task Shepherd API connection
21
- export TASK_SHEPHERD_API_URL="https://your-instance.taskshepherd.com/graphql"
22
- export TASK_SHEPHERD_API_KEY="tks_your_api_key_here"
36
+ # Register current directory as a workspace
37
+ task-shepherd-agent workspace register
23
38
 
24
- # Set your Claude API key
25
- export CLAUDE_API_KEY="sk-ant-api03-your_claude_key_here"
39
+ # Or register a specific directory
40
+ task-shepherd-agent workspace register --path /path/to/your/project
41
+
42
+ # Or scan common development directories automatically
43
+ task-shepherd-agent workspace scan-common
44
+
45
+ # View registered workspaces
46
+ task-shepherd-agent workspace list
26
47
  ```
27
48
 
28
49
  ### 3. Start Agent Service
@@ -32,10 +53,64 @@ task-shepherd-agent start
32
53
 
33
54
  The agent will:
34
55
  - Connect to your Task Shepherd instance
35
- - Register available workspaces
36
- - Begin processing assigned work
56
+ - Sync registered workspaces with the backend
57
+ - Begin polling for assigned work
37
58
  - Provide analytics dashboard at http://localhost:8548
38
59
 
60
+ ### Alternative: Environment Variables (Single Organization Only)
61
+
62
+ You can also configure the agent using environment variables for **single organization** deployments:
63
+
64
+ ```bash
65
+ # Set your Task Shepherd API connection
66
+ export TASK_SHEPHERD_API_URL="https://your-org.api.taskshepherd.com/graphql"
67
+ export TASK_SHEPHERD_API_KEY="tks_your_api_key_here"
68
+
69
+ # Set your Claude API key
70
+ export CLAUDE_API_KEY="sk-ant-api03-your_claude_key_here"
71
+
72
+ # Optional: Customize ports
73
+ export PORT=8547
74
+ export WEB_PORT=8548
75
+ ```
76
+
77
+ **⚠️ Note:** Environment variables only support single organization mode. For multi-organization support, use the init wizard and config file approach.
78
+
79
+ ### Managing Multiple Organizations
80
+
81
+ The agent supports working with multiple Task Shepherd organizations simultaneously. After initialization:
82
+
83
+ **To add additional organizations:**
84
+
85
+ 1. Edit the config file at `~/.task-shepherd-agent/config.json`
86
+ 2. Add organizations to the `organizations` array:
87
+
88
+ ```json
89
+ {
90
+ "agentId": "your-agent-id",
91
+ "organizations": [
92
+ {
93
+ "id": "org-1-id",
94
+ "name": "Organization 1",
95
+ "apiUrl": "https://org1.api.taskshepherd.com/graphql",
96
+ "apiKey": "tks_org1_key",
97
+ "enabled": true
98
+ },
99
+ {
100
+ "id": "org-2-id",
101
+ "name": "Organization 2",
102
+ "apiUrl": "https://org2.api.taskshepherd.com/graphql",
103
+ "apiKey": "tks_org2_key",
104
+ "enabled": true
105
+ }
106
+ ]
107
+ }
108
+ ```
109
+
110
+ 3. Restart the agent: `task-shepherd-agent start`
111
+
112
+ The agent will poll all enabled organizations for work and process tasks from any of them.
113
+
39
114
  ## Features
40
115
 
41
116
  ### 🤖 **AI-Powered Analysis**