@we-scrum/cli 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,63 @@
+# @we-scrum/cli
+
+Command-line tool and MCP server for the [we-scrum](https://github.com/BUONJG/we-scrum) application.
+
+## Installation
+
+```bash
+npm install -g @we-scrum/cli
+```
+
+## Authentication
+
+Authentication uses Google OAuth2. Credentials are stored locally in `~/.we-scrum.json` and refreshed automatically on each use.
+
+```bash
+we-scrum login    # Authenticate with your Google account
+we-scrum logout   # Remove stored credentials
+```
+
+## Commands
+
+### Select a project
+
+```bash
+we-scrum use-project                    # Interactive project picker
+we-scrum use-project --projectId <id>   # Set project directly
+```
+
+The selected project is persisted in `~/.we-scrum.json` and used by all subsequent commands.
+
+### MCP server
+
+Start the we-scrum MCP server over stdio transport:
+
+```bash
+we-scrum mcp
+we-scrum mcp --projectId <id>   # Override the active project for this session
+```
+
+## MCP integration
+
+Add the following to your MCP client configuration (e.g. Claude Desktop):
+
+```json
+{
+    "mcpServers": {
+        "we-scrum": {
+            "command": "we-scrum",
+            "args": ["mcp"]
+        }
+    }
+}
+```
+
+### Available tools
+
+| Tool | Description |
+|------|-------------|
+| `get_next_task` | Get the next pending task (status: ToDo) for a story, including its description, type template, section analysis, and the IDs needed to start or complete it. |
+
+## Requirements
+
+- Node.js 22+