137 lines
3.5 KiB
Markdown
137 lines
3.5 KiB
Markdown
# ai-proj Plugin
|
|
|
|
AI project task and requirement management through direct REST API calls.
|
|
|
|
## Features
|
|
|
|
- **Task Management**: Create, list, update, and complete tasks
|
|
- **Requirement Management**: Full requirement lifecycle (draft → review → development → complete)
|
|
- **Documentation**: Create and manage task documents
|
|
- **Daily Focus**: Plan and view today's tasks
|
|
- **Direct API Integration**: Uses REST API directly
|
|
|
|
## Quick Start
|
|
|
|
Just install the plugin and start using it:
|
|
|
|
```bash
|
|
/plugin install ai-proj-plugin@coolbuy-claude-plugins
|
|
```
|
|
|
|
That's it! No configuration needed.
|
|
|
|
## Usage
|
|
|
|
This plugin provides **Agent Skills** that I (Claude) automatically use when you mention relevant topics.
|
|
|
|
### Examples
|
|
|
|
**Task Management:**
|
|
- "Create a task: implement user authentication"
|
|
- "List all in-progress tasks"
|
|
- "Complete task 123"
|
|
- "Show me task 456"
|
|
|
|
**Requirement Management:**
|
|
- "Create requirement: add dark mode support"
|
|
- "List requirements in draft status"
|
|
- "Submit requirement 789 for review"
|
|
- "Approve requirement 789"
|
|
|
|
**Daily Focus:**
|
|
- "Show today's tasks"
|
|
- "Add task 123 to today's focus"
|
|
|
|
**Documents:**
|
|
- "Show the document for task 123"
|
|
- "Update task 456's document with: [content]"
|
|
|
|
## Configuration (Optional)
|
|
|
|
The plugin uses a default API token that works for most users. If you need to use a custom token:
|
|
|
|
### Environment Variable
|
|
|
|
```bash
|
|
export AIPROJ_TOKEN="your_custom_token_here"
|
|
```
|
|
|
|
Add this to your `~/.zshrc` or `~/.bashrc` to make it persistent.
|
|
|
|
## How It Works
|
|
|
|
This plugin uses a simple, straightforward approach:
|
|
|
|
1. Makes direct REST API calls to `https://ai.pipexerp.com/api/v1`
|
|
2. Uses `curl` for HTTP requests
|
|
3. Automatically finds the API token from:
|
|
- `$AIPROJ_TOKEN` environment variable
|
|
- Built-in default token
|
|
|
|
## Advantages
|
|
|
|
- ✅ **No setup required** - works immediately after installation
|
|
- ✅ **No server process** - simple and lightweight
|
|
- ✅ **No dependencies** - just needs `curl` (built into all systems)
|
|
- ✅ **Simple architecture** - direct API calls
|
|
- ✅ **Easy debugging** - can see exact API calls
|
|
|
|
## API Endpoints
|
|
|
|
The plugin uses these endpoints:
|
|
|
|
- `GET /tasks` - List tasks
|
|
- `POST /tasks` - Create task
|
|
- `GET /tasks/{id}` - Get task details
|
|
- `PATCH /tasks/{id}` - Update task
|
|
- `DELETE /tasks/{id}` - Delete task
|
|
- `GET /requirements` - List requirements
|
|
- `POST /requirements` - Create requirement
|
|
- `POST /requirements/{id}/actions` - Update requirement status
|
|
- `GET /tasks/{id}/document` - Get task document
|
|
- `PUT /tasks/{id}/document` - Update task document
|
|
- `GET /daily-focus/tasks` - Get today's tasks
|
|
- `POST /daily-focus/tasks` - Add task to today
|
|
|
|
## Troubleshooting
|
|
|
|
### "Unauthorized" or API errors
|
|
|
|
Check your token:
|
|
```bash
|
|
echo $AIPROJ_TOKEN
|
|
```
|
|
|
|
If empty, either set the environment variable or the plugin will use the default token.
|
|
|
|
### API not responding
|
|
|
|
Verify the API is accessible:
|
|
```bash
|
|
curl -I https://ai.pipexerp.com/api/v1/health
|
|
```
|
|
|
|
### Skills not working
|
|
|
|
- Agent Skills don't create slash commands
|
|
- Just ask naturally: "create a task", "list tasks", etc.
|
|
- The plugin is automatically active when installed
|
|
|
|
## Technical Details
|
|
|
|
**API Base**: `https://ai.pipexerp.com/api/v1`
|
|
**Authentication**: Bearer token in `Authorization` header
|
|
**Data Format**: JSON
|
|
**Date Format**: ISO 8601 (YYYY-MM-DD)
|
|
**Default Project ID**: 1
|
|
|
|
## Documentation
|
|
|
|
For detailed API documentation and examples, see `skills/SKILL.md`.
|
|
|
|
## Support
|
|
|
|
- Repository: git@gitea.pipexerp.com:huangjun/claude-marketplace.git
|
|
- Author: qiudl@zhiyuncai.com
|
|
|