cursortoys 0.2.0

package/llms.txt

@@ -0,0 +1,204 @@
+# CursorToys CLI - Instructions for LLMs
+
+## Overview
+
+The CursorToys CLI is a command-line utility for productivity, testing, and automation. It provides tools for HTTP testing, skill management, and more.
+
+## Available Commands
+
+### 1. HTTP Test (`cursortoys http test`)
+
+Run HTTP request files (`.req` / `.request`) as automated tests.
+
+**Basic usage:**
+```bash
+cursortoys http test
+```
+
+**Full command syntax:**
+```bash
+cursortoys http test [options]
+```
+
+**Options:**
+- `-p, --project <dir>`: Project directory (default: current working directory)
+- `--base-folder <name>`: Base folder name (default: `cursor`; or set `CURSORTOYS_BASE_FOLDER`)
+- `--environments-folder <name>`: Environments subfolder (default: `.environments`)
+- `-e, --env <name>`: Environment to use (overrides `# @env` in file)
+- `-t, --timeout <seconds>`: Request timeout in seconds (default: `10`)
+- `-f, --file <path>`: Run a single `.req` or `.request` file
+- `-V, --verbose`: Show request and response details
+- `--var <key=value>`: Override variables (can be repeated)
+
+**Examples:**
+```bash
+# Run all tests
+cursortoys http test
+
+# Run with verbose output
+cursortoys http test -V
+
+# Run specific file
+cursortoys http test -f .cursor/http/api.req
+
+# Override environment and variables
+cursortoys http test -e qa --var BASE_URL=https://staging.api.com --var API_KEY=secret
+```
+
+**Request File Format:**
+- REST Client format: `METHOD URL` followed by headers and body
+- Multiple requests separated by `###`
+- Variables: `# @var VAR_NAME=value`
+- Environment: `# @env name`
+- Substitution: `{{VAR_NAME}}`
+- Delay: `# @delay(milliseconds)` - adds delay before executing the request block
+
+**Assertions:**
+Supports various assertion types:
+- Status code: `# @assert response.status == 200`
+- Headers: `# @assert response.headers['content-type'] contains 'application/json'`
+- Body: `# @assert response.body.data.length > 0`
+- JSON path: `# @assert response.body.user.name == "John"`
+
+### 2. Skill Add (`cursortoys skill add`)
+
+Create a new skill file with a template.
+
+**Basic usage:**
+```bash
+cursortoys skill add <name>
+```
+
+**Full command syntax:**
+```bash
+cursortoys skill add <name> [options]
+```
+
+**Options:**
+- `-d, --description <text>`: Skill description
+- `-t, --target <type>`: Target directory (`personal` or `project`, default: `personal`)
+- `-p, --project <dir>`: Project directory (required if target is `project`)
+- `--base-folder <name>`: Base folder name (default: `cursor`)
+
+**Examples:**
+```bash
+# Create personal skill (default)
+cursortoys skill add my-skill
+
+# Create personal skill with description
+cursortoys skill add http-testing -d "Skill for testing HTTP APIs"
+
+# Create project skill
+cursortoys skill add api-docs -t project -p /path/to/project
+
+# Create project skill in current directory
+cursortoys skill add api-docs -t project -p .
+
+# Custom base folder
+cursortoys skill add my-skill --base-folder vscode
+```
+
+**Output:**
+Creates a `SKILL.md` file in:
+- Personal: `~/.cursor/skills/skill-name/SKILL.md`
+- Project: `{project}/.cursor/skills/skill-name/SKILL.md`
+
+The file contains a template with:
+- Description section
+- When to Use section
+- How It Works section
+- Examples section
+- Notes section
+- Related Skills section
+
+### 3. LLM Instructions (`cursortoys --llm`)
+
+Display comprehensive instructions for LLMs on how to use the CLI.
+
+**Usage:**
+```bash
+cursortoys --llm
+```
+
+**Output:**
+Displays this file (llms.txt) with all documentation about commands, options, usage patterns, and best practices.
+
+## Environment Variables
+
+- `CURSORTOYS_BASE_FOLDER`: Default base folder (default: `cursor`)
+- `CURSORTOYS_ENVIRONMENTS_FOLDER`: Environments subfolder (default: `.environments`)
+
+## Paths and Structure
+
+### HTTP Testing
+- **HTTP folder**: `{workspace}/.{baseFolder}/http/`
+- **Environments**: `{workspace}/.{baseFolder}/http/{environmentsFolder}/`
+- **Environment files**: `.env`, `.env.dev`, `.env.qa`, `.env.prod`, etc.
+
+### Skills
+- **Personal skills**: `~/.cursor/skills/{skill-name}/SKILL.md`
+- **Project skills**: `{project}/.cursor/skills/{skill-name}/SKILL.md`
+
+## Exit Codes
+
+- `0`: Success (all tests passed, command completed successfully)
+- `1`: Failure (tests failed, error occurred)
+
+## Requirements
+
+- Node.js 18+
+- `curl` installed and on PATH (for HTTP testing)
+
+## Integration with VS Code/Cursor
+
+The CLI uses the same format and conventions as the CursorToys VS Code extension:
+- Same `.req` / `.request` file format
+- Same environment variable resolution
+- Same base folder configuration
+- Skills are compatible with Cursor AI Agent Skills
+
+## Tips for LLMs
+
+1. **HTTP Testing**: When users want to test APIs, suggest using `cursortoys http test` with appropriate options
+2. **Skill Creation**: When users want to create reusable AI instructions, use `cursortoys skill add`
+3. **Verbose Mode**: Use `-V` when debugging to see full request/response details
+4. **Environment Switching**: Use `-e` to switch between dev/qa/prod environments
+5. **Variable Overrides**: Use `--var` to override specific variables without modifying files
+6. **Project vs Personal**: Skills can be personal (shared across projects) or project-specific
+
+## Common Use Cases
+
+### Use Case 1: API Testing in CI/CD
+```bash
+# Run all tests with production environment
+cursortoys http test -e prod --timeout 30
+```
+
+### Use Case 2: Local Development Testing
+```bash
+# Test specific endpoint with verbose output
+cursortoys http test -f .cursor/http/users.req -V --var BASE_URL=http://localhost:3000
+```
+
+### Use Case 3: Rate-Limited API Testing
+```bash
+# Test API with delays between requests (using #@delay in .req files)
+cursortoys http test -f .cursor/http/rate-limited-api.req
+```
+
+### Use Case 4: Creating Reusable Skills
+```bash
+# Create a skill for API documentation standards
+cursortoys skill add api-docs -d "Standards for documenting REST APIs" -t project
+```
+
+## Error Handling
+
+The CLI provides clear error messages:
+- File not found errors
+- Invalid request format
+- Network errors
+- Assertion failures
+- Environment/variable resolution issues
+
+All errors are displayed in red with relevant context.

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "cursortoys",
+  "version": "0.2.0",
+  "description": "Command-line utilities for CursorToys - HTTP testing, automation, and productivity tools",
+  "main": "dist/cli.js",
+  "bin": {
+    "cursortoys": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc -p .",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "cursortoys",
+    "cli",
+    "utilities",
+    "productivity",
+    "http",
+    "rest",
+    "testing",
+    "api",
+    "automation",
+    "request",
+    "curl",
+    "vscode",
+    "cursor",
+    "skills",
+    "ai",
+    "llm"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yourusername/cursortoys-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yourusername/cursortoys-cli/issues"
+  },
+  "homepage": "https://github.com/yourusername/cursortoys-cli#readme",
+  "files": [
+    "dist",
+    "llms.txt",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^12.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}