docs: sync core dev and core go with CLI
Updated by technical writer agents: - core dev: added task management, api, sync, ci commands - core dev: fixed all flag discrepancies - core go: added work subcommands (init, sync, use) - core go: added missing flags (--json, --check, --open, --threshold) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Snider
parent
ab1a808657
commit
dea8f59c10
12 changed files with 595 additions and 218 deletions
141
docs/cmd/TODO.md
141
docs/cmd/TODO.md
|
|
@ -4,26 +4,6 @@ Commands and flags found in CLI but missing from documentation.
|
|||
|
||||
## Missing Commands
|
||||
|
||||
### core dev
|
||||
|
||||
- `core dev api` - Tools for managing service APIs
|
||||
- `core dev api sync` - Synchronizes the public service APIs with their internal implementations
|
||||
- `core dev sync` - Synchronizes the public service APIs (duplicate of api sync)
|
||||
- `core dev ci` - Check CI status across all repos
|
||||
- `core dev tasks` - List available tasks from core-agentic
|
||||
- `core dev task` - Show task details or auto-select a task
|
||||
- `core dev task:update` - Update task status or progress
|
||||
- `core dev task:complete` - Mark a task as completed
|
||||
- `core dev task:commit` - Auto-commit changes with task reference
|
||||
- `core dev task:pr` - Create a pull request for a task
|
||||
|
||||
### core go
|
||||
|
||||
- `core go work` - Workspace management (init, sync, use)
|
||||
- `core go work sync` - Sync workspace
|
||||
- `core go work init` - Initialize workspace
|
||||
- `core go work use` - Add module to workspace
|
||||
|
||||
### core build
|
||||
|
||||
- `core build from-path` - Build from a local directory
|
||||
|
|
@ -43,99 +23,6 @@ Commands and flags found in CLI but missing from documentation.
|
|||
|
||||
## Missing Flags
|
||||
|
||||
### core dev boot
|
||||
|
||||
- `--fresh` - Stop existing and start fresh
|
||||
|
||||
### core dev claude
|
||||
|
||||
- `--model` - Model to use (opus, sonnet)
|
||||
|
||||
### core dev install
|
||||
|
||||
- Docs mention `--source` and `--force` flags that don't appear in CLI help
|
||||
|
||||
### core dev tasks
|
||||
|
||||
- `--status` - Filter by status (pending, in_progress, completed, blocked)
|
||||
- `--priority` - Filter by priority (critical, high, medium, low)
|
||||
- `--labels` - Filter by labels (comma-separated)
|
||||
- `--project` - Filter by project
|
||||
- `--limit` - Max number of tasks to return (default 20)
|
||||
|
||||
### core dev task
|
||||
|
||||
- `--auto` - Auto-select highest priority pending task
|
||||
- `--claim` - Claim the task after showing details
|
||||
- `--context` - Show gathered context for AI collaboration
|
||||
|
||||
### core dev task:update
|
||||
|
||||
- `--status` - New status (pending, in_progress, completed, blocked)
|
||||
- `--progress` - Progress percentage (0-100)
|
||||
- `--notes` - Notes about the update
|
||||
|
||||
### core dev task:complete
|
||||
|
||||
- `--output` - Summary of the completed work
|
||||
- `--failed` - Mark the task as failed
|
||||
- `--error` - Error message if failed
|
||||
|
||||
### core dev task:commit
|
||||
|
||||
- `--message` / `-m` - Commit message
|
||||
- `--scope` - Scope for the commit type
|
||||
- `--push` - Push changes after committing
|
||||
|
||||
### core dev task:pr
|
||||
|
||||
- `--title` - PR title
|
||||
- `--draft` - Create as draft PR
|
||||
- `--labels` - Labels to add (comma-separated)
|
||||
- `--base` - Base branch (defaults to main)
|
||||
|
||||
### core dev health
|
||||
|
||||
- `--verbose` - Show detailed breakdown
|
||||
|
||||
### core dev issues
|
||||
|
||||
- `--assignee` - Filter by assignee (use @me for yourself)
|
||||
- `--limit` - Max issues per repo (default 10)
|
||||
- Docs mention `--label` which is not in CLI; CLI has `--assignee` instead
|
||||
|
||||
### core dev reviews
|
||||
|
||||
- `--all` - Show all PRs including drafts
|
||||
- `--author` - Filter by PR author
|
||||
|
||||
### core dev ci
|
||||
|
||||
- `--branch` - Filter by branch (default: main)
|
||||
- `--failed` - Show only failed runs
|
||||
|
||||
### core dev update
|
||||
|
||||
- `--apply` - Download and apply the update (docs mention `--force` instead)
|
||||
|
||||
### core dev test
|
||||
|
||||
- `--name` - Run named test command from .core/test.yaml
|
||||
- Docs mention `--unit` which is not in CLI
|
||||
|
||||
### core go test
|
||||
|
||||
- `--json` - Output JSON results
|
||||
|
||||
### core go cov
|
||||
|
||||
- `--open` - Generate and open HTML report in browser
|
||||
- `--threshold` - Minimum coverage percentage (exit 1 if below)
|
||||
|
||||
### core go fmt
|
||||
|
||||
- `--check` - Check only, exit 1 if not formatted
|
||||
|
||||
### core build
|
||||
|
||||
- `--archive` - Create archives (tar.gz for linux/darwin, zip for windows)
|
||||
|
|
@ -198,30 +85,6 @@ Commands and flags found in CLI but missing from documentation.
|
|||
- Docs describe `core sdk generate` command but CLI only has `core sdk diff` and `core sdk validate`
|
||||
- SDK generation is actually at `core build sdk`, not `core sdk generate`
|
||||
|
||||
### core dev install
|
||||
|
||||
- Docs mention `--source` and `--force` flags that are not shown in CLI help
|
||||
|
||||
### core dev update
|
||||
|
||||
- Docs mention `--force` flag but CLI has `--apply` instead
|
||||
|
||||
### core dev test
|
||||
|
||||
- Docs mention `--unit` flag but CLI has `--name` flag
|
||||
|
||||
### core dev issues
|
||||
|
||||
- Docs mention `--label` flag but CLI has `--assignee` flag and no `--label`
|
||||
|
||||
### core dev push
|
||||
|
||||
- Docs mention `--all` flag but CLI only has `--force` flag
|
||||
|
||||
### core dev pull
|
||||
|
||||
- Docs mention `--rebase` flag but CLI only has `--all` flag
|
||||
|
||||
### core setup
|
||||
|
||||
- Docs mention `--path` and `--ssh` flags but CLI has `--dry-run` and `--only` flags instead
|
||||
|
|
@ -234,7 +97,3 @@ Commands and flags found in CLI but missing from documentation.
|
|||
### core php serve
|
||||
|
||||
- Docs mention `--production` flag but CLI has different flags: `--name`, `--tag`, `--port`, `--https-port`, `-d`, `--env-file`, `--container`
|
||||
|
||||
### core dev work/commit/push flags
|
||||
|
||||
- Documentation flags don't match CLI flags in several places (e.g., `--message` vs no such flag in CLI)
|
||||
|
|
|
|||
|
|
@ -6,20 +6,35 @@
|
|||
# Quick status
|
||||
core dev health
|
||||
|
||||
# Detailed breakdown
|
||||
core dev health --verbose
|
||||
|
||||
# Full workflow
|
||||
core dev work
|
||||
|
||||
# Status only
|
||||
core dev work --status
|
||||
|
||||
# Commit and push
|
||||
core dev work --commit
|
||||
|
||||
# Commit dirty repos
|
||||
core dev commit
|
||||
|
||||
# Commit all without prompting
|
||||
core dev commit --all
|
||||
|
||||
# Push unpushed
|
||||
core dev push
|
||||
|
||||
# Pull behind
|
||||
# Push without confirmation
|
||||
core dev push --force
|
||||
|
||||
# Pull behind repos
|
||||
core dev pull
|
||||
|
||||
# Pull all repos
|
||||
core dev pull --all
|
||||
```
|
||||
|
||||
## GitHub Integration
|
||||
|
|
@ -28,11 +43,29 @@ core dev pull
|
|||
# Open issues
|
||||
core dev issues
|
||||
|
||||
# Include closed
|
||||
core dev issues --all
|
||||
# Filter by assignee
|
||||
core dev issues --assignee @me
|
||||
|
||||
# Limit results
|
||||
core dev issues --limit 5
|
||||
|
||||
# PRs needing review
|
||||
core dev reviews
|
||||
|
||||
# All PRs including drafts
|
||||
core dev reviews --all
|
||||
|
||||
# Filter by author
|
||||
core dev reviews --author username
|
||||
|
||||
# CI status
|
||||
core dev ci
|
||||
|
||||
# Only failed runs
|
||||
core dev ci --failed
|
||||
|
||||
# Specific branch
|
||||
core dev ci --branch develop
|
||||
```
|
||||
|
||||
## Dependency Analysis
|
||||
|
|
@ -42,6 +75,62 @@ core dev reviews
|
|||
core dev impact core-php
|
||||
```
|
||||
|
||||
## Task Management
|
||||
|
||||
```bash
|
||||
# List tasks
|
||||
core dev tasks
|
||||
|
||||
# Filter by status and priority
|
||||
core dev tasks --status pending --priority high
|
||||
|
||||
# Filter by labels
|
||||
core dev tasks --labels bug,urgent
|
||||
|
||||
# Show task details
|
||||
core dev task abc123
|
||||
|
||||
# Auto-select highest priority task
|
||||
core dev task --auto
|
||||
|
||||
# Claim a task
|
||||
core dev task abc123 --claim
|
||||
|
||||
# Update task status
|
||||
core dev task:update abc123 --status in_progress
|
||||
|
||||
# Add progress notes
|
||||
core dev task:update abc123 --progress 50 --notes 'Halfway done'
|
||||
|
||||
# Complete a task
|
||||
core dev task:complete abc123 --output 'Feature implemented'
|
||||
|
||||
# Mark as failed
|
||||
core dev task:complete abc123 --failed --error 'Build failed'
|
||||
|
||||
# Commit with task reference
|
||||
core dev task:commit abc123 -m 'add user authentication'
|
||||
|
||||
# Commit with scope and push
|
||||
core dev task:commit abc123 -m 'fix login bug' --scope auth --push
|
||||
|
||||
# Create PR for task
|
||||
core dev task:pr abc123
|
||||
|
||||
# Create draft PR with labels
|
||||
core dev task:pr abc123 --draft --labels 'enhancement,needs-review'
|
||||
```
|
||||
|
||||
## Service API Management
|
||||
|
||||
```bash
|
||||
# Synchronize public service APIs
|
||||
core dev sync
|
||||
|
||||
# Or using the api command
|
||||
core dev api sync
|
||||
```
|
||||
|
||||
## Dev Environment
|
||||
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -13,7 +13,21 @@ Multi-repo workflow and portable development environment.
|
|||
| `pull` | Pull repos that are behind |
|
||||
| `issues` | List open issues |
|
||||
| `reviews` | List PRs needing review |
|
||||
| `ci` | Check CI status |
|
||||
| `impact` | Show dependency impact |
|
||||
| `api` | Tools for managing service APIs |
|
||||
| `sync` | Synchronize public service APIs |
|
||||
|
||||
## Task Management Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `tasks` | List available tasks from core-agentic |
|
||||
| `task` | Show task details or auto-select a task |
|
||||
| `task:update` | Update task status or progress |
|
||||
| `task:complete` | Mark a task as completed |
|
||||
| `task:commit` | Auto-commit changes with task reference |
|
||||
| `task:pr` | Create a pull request for a task |
|
||||
|
||||
## Dev Environment Commands
|
||||
|
||||
|
|
@ -54,24 +68,16 @@ core dev serve
|
|||
Download the core-devops image for your platform.
|
||||
|
||||
```bash
|
||||
core dev install [flags]
|
||||
core dev install
|
||||
```
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--source` | Image source: `github`, `registry`, `cdn` (default: auto) |
|
||||
| `--force` | Force re-download even if exists |
|
||||
Downloads the platform-specific dev environment image including Go, PHP, Node.js, Python, Docker, and Claude CLI. Downloads are cached at `~/.core/images/`.
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Download image (auto-detects platform)
|
||||
core dev install
|
||||
|
||||
# Force re-download
|
||||
core dev install --force
|
||||
```
|
||||
|
||||
## dev boot
|
||||
|
|
@ -87,8 +93,8 @@ core dev boot [flags]
|
|||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--memory` | Memory allocation in MB (default: 4096) |
|
||||
| `--cpus` | Number of CPUs (default: 4) |
|
||||
| `--name` | Container name (default: core-dev) |
|
||||
| `--cpus` | Number of CPUs (default: 2) |
|
||||
| `--fresh` | Stop existing and start fresh |
|
||||
|
||||
### Examples
|
||||
|
||||
|
|
@ -97,7 +103,10 @@ core dev boot [flags]
|
|||
core dev boot
|
||||
|
||||
# More resources
|
||||
core dev boot --memory 8192 --cpus 8
|
||||
core dev boot --memory 8192 --cpus 4
|
||||
|
||||
# Fresh start
|
||||
core dev boot --fresh
|
||||
```
|
||||
|
||||
## dev shell
|
||||
|
|
@ -105,9 +114,11 @@ core dev boot --memory 8192 --cpus 8
|
|||
Open a shell in the running environment.
|
||||
|
||||
```bash
|
||||
core dev shell [flags]
|
||||
core dev shell [flags] [-- command]
|
||||
```
|
||||
|
||||
Uses SSH by default, or serial console with `--console`.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|
|
@ -122,6 +133,9 @@ core dev shell
|
|||
|
||||
# Serial console (for debugging)
|
||||
core dev shell --console
|
||||
|
||||
# Run a command
|
||||
core dev shell -- ls -la
|
||||
```
|
||||
|
||||
## dev serve
|
||||
|
|
@ -170,11 +184,11 @@ core dev test [flags] [-- custom command]
|
|||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--unit` | Run only unit tests |
|
||||
| `--name` | Run named test command from `.core/test.yaml` |
|
||||
|
||||
### Test Detection
|
||||
|
||||
Core auto-detects the test framework:
|
||||
Core auto-detects the test framework or uses `.core/test.yaml`:
|
||||
|
||||
1. `.core/test.yaml` - Custom config
|
||||
2. `composer.json` → `composer test`
|
||||
|
|
@ -189,6 +203,9 @@ Core auto-detects the test framework:
|
|||
# Auto-detect and run tests
|
||||
core dev test
|
||||
|
||||
# Run named test from config
|
||||
core dev test --name integration
|
||||
|
||||
# Custom command
|
||||
core dev test -- go test -v ./pkg/...
|
||||
```
|
||||
|
|
@ -225,8 +242,9 @@ core dev claude [flags]
|
|||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--no-auth` | Clean session without host credentials |
|
||||
| `--auth` | Selective auth forwarding (e.g., `gh,anthropic`) |
|
||||
| `--model` | Model to use (`opus`, `sonnet`) |
|
||||
| `--no-auth` | Don't forward any auth credentials |
|
||||
| `--auth` | Selective auth forwarding (`gh`, `anthropic`, `ssh`, `git`) |
|
||||
|
||||
### What Gets Forwarded
|
||||
|
||||
|
|
@ -242,11 +260,14 @@ By default, these are forwarded to the sandbox:
|
|||
# Full auth forwarding (default)
|
||||
core dev claude
|
||||
|
||||
# Use Opus model
|
||||
core dev claude --model opus
|
||||
|
||||
# Clean sandbox
|
||||
core dev claude --no-auth
|
||||
|
||||
# Only GitHub auth
|
||||
core dev claude --auth=gh
|
||||
# Only GitHub and Anthropic auth
|
||||
core dev claude --auth gh,anthropic
|
||||
```
|
||||
|
||||
### Why Use This?
|
||||
|
|
@ -273,7 +294,7 @@ Output includes:
|
|||
|
||||
## dev update
|
||||
|
||||
Check for and download newer images.
|
||||
Check for and apply updates.
|
||||
|
||||
```bash
|
||||
core dev update [flags]
|
||||
|
|
@ -283,7 +304,17 @@ core dev update [flags]
|
|||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--force` | Force download even if up to date |
|
||||
| `--apply` | Download and apply the update |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Check for updates
|
||||
core dev update
|
||||
|
||||
# Apply available update
|
||||
core dev update --apply
|
||||
```
|
||||
|
||||
## Embedded Tools
|
||||
|
||||
|
|
@ -339,6 +370,223 @@ Images are stored in `~/.core/images/`:
|
|||
└── manifest.json
|
||||
```
|
||||
|
||||
## Multi-Repo Commands
|
||||
|
||||
See the [work](work/) page for detailed documentation on multi-repo commands.
|
||||
|
||||
### dev ci
|
||||
|
||||
Check GitHub Actions workflow status across all repos.
|
||||
|
||||
```bash
|
||||
core dev ci [flags]
|
||||
```
|
||||
|
||||
#### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--branch` | Filter by branch (default: main) |
|
||||
| `--failed` | Show only failed runs |
|
||||
|
||||
Requires the `gh` CLI to be installed and authenticated.
|
||||
|
||||
### dev api
|
||||
|
||||
Tools for managing service APIs.
|
||||
|
||||
```bash
|
||||
core dev api sync
|
||||
```
|
||||
|
||||
Synchronizes the public service APIs with their internal implementations.
|
||||
|
||||
### dev sync
|
||||
|
||||
Alias for `core dev api sync`. Synchronizes the public service APIs with their internal implementations.
|
||||
|
||||
```bash
|
||||
core dev sync
|
||||
```
|
||||
|
||||
This command scans the `pkg` directory for services and ensures that the top-level public API for each service is in sync with its internal implementation. It automatically generates the necessary Go files with type aliases.
|
||||
|
||||
## Task Management Commands
|
||||
|
||||
The task commands integrate with the core-agentic service for AI-powered task management.
|
||||
|
||||
### Configuration
|
||||
|
||||
Task commands load configuration from:
|
||||
1. Environment variables (`AGENTIC_TOKEN`, `AGENTIC_BASE_URL`)
|
||||
2. `.env` file in current directory
|
||||
3. `~/.core/agentic.yaml`
|
||||
|
||||
### dev tasks
|
||||
|
||||
List available tasks from core-agentic.
|
||||
|
||||
```bash
|
||||
core dev tasks [flags]
|
||||
```
|
||||
|
||||
#### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--status` | Filter by status (`pending`, `in_progress`, `completed`, `blocked`) |
|
||||
| `--priority` | Filter by priority (`critical`, `high`, `medium`, `low`) |
|
||||
| `--labels` | Filter by labels (comma-separated) |
|
||||
| `--project` | Filter by project |
|
||||
| `--limit` | Max number of tasks to return (default: 20) |
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
core dev tasks
|
||||
core dev tasks --status pending --priority high
|
||||
core dev tasks --labels bug,urgent
|
||||
```
|
||||
|
||||
### dev task
|
||||
|
||||
Show task details or auto-select a task.
|
||||
|
||||
```bash
|
||||
core dev task [task-id] [flags]
|
||||
```
|
||||
|
||||
#### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--auto` | Auto-select highest priority pending task |
|
||||
| `--claim` | Claim the task after showing details |
|
||||
| `--context` | Show gathered context for AI collaboration |
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
# Show task details
|
||||
core dev task abc123
|
||||
|
||||
# Show and claim
|
||||
core dev task abc123 --claim
|
||||
|
||||
# Show with context
|
||||
core dev task abc123 --context
|
||||
|
||||
# Auto-select highest priority pending task
|
||||
core dev task --auto
|
||||
```
|
||||
|
||||
### dev task:update
|
||||
|
||||
Update a task's status, progress, or notes.
|
||||
|
||||
```bash
|
||||
core dev task:update <task-id> [flags]
|
||||
```
|
||||
|
||||
#### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--status` | New status (`pending`, `in_progress`, `completed`, `blocked`) |
|
||||
| `--progress` | Progress percentage (0-100) |
|
||||
| `--notes` | Notes about the update |
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
core dev task:update abc123 --status in_progress
|
||||
core dev task:update abc123 --progress 50 --notes 'Halfway done'
|
||||
```
|
||||
|
||||
### dev task:complete
|
||||
|
||||
Mark a task as completed with optional output and artifacts.
|
||||
|
||||
```bash
|
||||
core dev task:complete <task-id> [flags]
|
||||
```
|
||||
|
||||
#### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--output` | Summary of the completed work |
|
||||
| `--failed` | Mark the task as failed |
|
||||
| `--error` | Error message if failed |
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
core dev task:complete abc123 --output 'Feature implemented'
|
||||
core dev task:complete abc123 --failed --error 'Build failed'
|
||||
```
|
||||
|
||||
### dev task:commit
|
||||
|
||||
Create a git commit with a task reference and co-author attribution.
|
||||
|
||||
```bash
|
||||
core dev task:commit <task-id> [flags]
|
||||
```
|
||||
|
||||
Commit message format:
|
||||
```
|
||||
feat(scope): description
|
||||
|
||||
Task: #123
|
||||
Co-Authored-By: Claude <noreply@anthropic.com>
|
||||
```
|
||||
|
||||
#### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `-m`, `--message` | Commit message (without task reference) |
|
||||
| `--scope` | Scope for the commit type (e.g., `auth`, `api`, `ui`) |
|
||||
| `--push` | Push changes after committing |
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
core dev task:commit abc123 --message 'add user authentication'
|
||||
core dev task:commit abc123 -m 'fix login bug' --scope auth
|
||||
core dev task:commit abc123 -m 'update docs' --push
|
||||
```
|
||||
|
||||
### dev task:pr
|
||||
|
||||
Create a GitHub pull request linked to a task.
|
||||
|
||||
```bash
|
||||
core dev task:pr <task-id> [flags]
|
||||
```
|
||||
|
||||
Requires the GitHub CLI (`gh`) to be installed and authenticated.
|
||||
|
||||
#### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--title` | PR title (defaults to task title) |
|
||||
| `--base` | Base branch (defaults to main) |
|
||||
| `--draft` | Create as draft PR |
|
||||
| `--labels` | Labels to add (comma-separated) |
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
core dev task:pr abc123
|
||||
core dev task:pr abc123 --title 'Add authentication feature'
|
||||
core dev task:pr abc123 --draft --labels 'enhancement,needs-review'
|
||||
core dev task:pr abc123 --base develop
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [work](work/) - Multi-repo workflow commands (`core dev work`, `core dev health`, etc.)
|
||||
|
|
|
|||
|
|
@ -12,26 +12,77 @@ The `core dev work` command and related subcommands help manage multiple reposit
|
|||
|---------|-------------|
|
||||
| `core dev work` | Full workflow: status + commit + push |
|
||||
| `core dev work --status` | Status table only |
|
||||
| `core dev work --commit` | Use Claude to commit dirty repos |
|
||||
| `core dev health` | Quick health check across all repos |
|
||||
| `core dev issues` | List open issues across all repos |
|
||||
| `core dev reviews` | List PRs needing review |
|
||||
| `core dev commit` | Claude-assisted commits across repos |
|
||||
| `core dev push` | Push commits across all repos |
|
||||
| `core dev pull` | Pull updates across all repos |
|
||||
| `core dev issues` | List open issues across all repos |
|
||||
| `core dev reviews` | List PRs needing review |
|
||||
| `core dev ci` | Check CI status across all repos |
|
||||
| `core dev impact` | Show impact of changing a repo |
|
||||
|
||||
## core dev work
|
||||
|
||||
Manage git status, commits, and pushes across multiple repositories.
|
||||
|
||||
```bash
|
||||
core dev work [flags]
|
||||
```
|
||||
|
||||
Reads `repos.yaml` to discover repositories and their relationships. Shows status, optionally commits with Claude, and pushes changes.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--status` | Show status only, don't push |
|
||||
| `--commit` | Use Claude to commit dirty repos before pushing |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Full workflow
|
||||
core dev work
|
||||
|
||||
# Status only
|
||||
core dev work --status
|
||||
|
||||
# Commit and push
|
||||
core dev work --commit
|
||||
```
|
||||
|
||||
## core dev health
|
||||
|
||||
Quick health check showing status of all repos.
|
||||
Quick health check showing summary of repository health across all repos.
|
||||
|
||||
```bash
|
||||
core dev health
|
||||
core dev health [flags]
|
||||
```
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--verbose` | Show detailed breakdown |
|
||||
|
||||
Output shows:
|
||||
- Git status (clean/dirty)
|
||||
- Current branch
|
||||
- Commits ahead/behind remote
|
||||
- Total repos
|
||||
- Dirty repos
|
||||
- Unpushed commits
|
||||
- Repos behind remote
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Quick summary
|
||||
core dev health
|
||||
|
||||
# Detailed breakdown
|
||||
core dev health --verbose
|
||||
```
|
||||
|
||||
## core dev issues
|
||||
|
||||
|
|
@ -41,26 +92,59 @@ List open issues across all repositories.
|
|||
core dev issues [flags]
|
||||
```
|
||||
|
||||
Fetches open issues from GitHub for all repos in the registry. Requires the `gh` CLI to be installed and authenticated.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--assignee` | Filter by assignee |
|
||||
| `--label` | Filter by label |
|
||||
| `--limit` | Max issues per repo |
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--assignee` | Filter by assignee (use `@me` for yourself) |
|
||||
| `--limit` | Max issues per repo (default: 10) |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# List all open issues
|
||||
core dev issues
|
||||
|
||||
# Filter by assignee
|
||||
core dev issues --assignee @me
|
||||
|
||||
# Limit results
|
||||
core dev issues --limit 5
|
||||
```
|
||||
|
||||
## core dev reviews
|
||||
|
||||
List pull requests needing review.
|
||||
List pull requests needing review across all repos.
|
||||
|
||||
```bash
|
||||
core dev reviews [flags]
|
||||
```
|
||||
|
||||
Shows PRs where:
|
||||
- You are a requested reviewer
|
||||
- PR is open and not draft
|
||||
- CI is passing
|
||||
Fetches open PRs from GitHub for all repos in the registry. Shows review status (approved, changes requested, pending). Requires the `gh` CLI to be installed and authenticated.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--all` | Show all PRs including drafts |
|
||||
| `--author` | Filter by PR author |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# List PRs needing review
|
||||
core dev reviews
|
||||
|
||||
# Show all PRs including drafts
|
||||
core dev reviews --all
|
||||
|
||||
# Filter by author
|
||||
core dev reviews --author username
|
||||
```
|
||||
|
||||
## core dev commit
|
||||
|
||||
|
|
@ -70,14 +154,24 @@ Create commits across repos with Claude assistance.
|
|||
core dev commit [flags]
|
||||
```
|
||||
|
||||
Uses Claude to create commits for dirty repos. Shows uncommitted changes and invokes Claude to generate commit messages.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--message` | Commit message (auto-generated if not provided) |
|
||||
| `--all` | Commit in all dirty repos |
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--all` | Commit all dirty repos without prompting |
|
||||
|
||||
Claude analyzes changes and suggests conventional commit messages.
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Commit with prompts
|
||||
core dev commit
|
||||
|
||||
# Commit all automatically
|
||||
core dev commit --all
|
||||
```
|
||||
|
||||
## core dev push
|
||||
|
||||
|
|
@ -87,12 +181,24 @@ Push commits across all repos.
|
|||
core dev push [flags]
|
||||
```
|
||||
|
||||
Pushes unpushed commits for all repos. Shows repos with commits to push and confirms before pushing.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--all` | Push all repos with unpushed commits |
|
||||
| `--force` | Force push (use with caution) |
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--force` | Skip confirmation prompt |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Push with confirmation
|
||||
core dev push
|
||||
|
||||
# Skip confirmation
|
||||
core dev push --force
|
||||
```
|
||||
|
||||
## core dev pull
|
||||
|
||||
|
|
@ -102,25 +208,78 @@ Pull updates across all repos.
|
|||
core dev pull [flags]
|
||||
```
|
||||
|
||||
Pulls updates for all repos. By default only pulls repos that are behind. Use `--all` to pull all repos.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--all` | Pull all repos |
|
||||
| `--rebase` | Rebase instead of merge |
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--all` | Pull all repos, not just those behind |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Pull repos that are behind
|
||||
core dev pull
|
||||
|
||||
# Pull all repos
|
||||
core dev pull --all
|
||||
```
|
||||
|
||||
## core dev ci
|
||||
|
||||
Check GitHub Actions workflow status across all repos.
|
||||
|
||||
```bash
|
||||
core dev ci [flags]
|
||||
```
|
||||
|
||||
Fetches GitHub Actions workflow status for all repos. Shows latest run status for each repo. Requires the `gh` CLI to be installed and authenticated.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
| `--branch` | Filter by branch (default: main) |
|
||||
| `--failed` | Show only failed runs |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Show CI status for all repos
|
||||
core dev ci
|
||||
|
||||
# Show only failed runs
|
||||
core dev ci --failed
|
||||
|
||||
# Check specific branch
|
||||
core dev ci --branch develop
|
||||
```
|
||||
|
||||
## core dev impact
|
||||
|
||||
Show the impact of changing a repository.
|
||||
|
||||
```bash
|
||||
core dev impact <repo>
|
||||
core dev impact <repo> [flags]
|
||||
```
|
||||
|
||||
Shows:
|
||||
- Dependent repos
|
||||
- Reverse dependencies
|
||||
- Potential breaking changes
|
||||
Analyzes the dependency graph to show which repos would be affected by changes to the specified repo.
|
||||
|
||||
### Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--registry` | Path to `repos.yaml` (auto-detected if not specified) |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Show impact of changing core-php
|
||||
core dev impact core-php
|
||||
```
|
||||
|
||||
## Registry
|
||||
|
||||
|
|
|
|||
|
|
@ -13,9 +13,9 @@ core go cov [flags]
|
|||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--pkg` | Package to test (default: `./...`) |
|
||||
| `--html` | Generate HTML report |
|
||||
| `--open` | Open in browser |
|
||||
| `--threshold` | Fail if coverage below % |
|
||||
| `--html` | Generate HTML coverage report |
|
||||
| `--open` | Generate and open HTML report in browser |
|
||||
| `--threshold` | Minimum coverage percentage (exit 1 if below) |
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -12,13 +12,14 @@ core go fmt [flags]
|
|||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--fix` | Apply fixes (default: check only) |
|
||||
| `--diff` | Show diff |
|
||||
| `--fix` | Fix formatting in place |
|
||||
| `--diff` | Show diff of changes |
|
||||
| `--check` | Check only, exit 1 if not formatted |
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
core go fmt # Check
|
||||
core go fmt --fix # Apply fixes
|
||||
core go fmt # Check formatting
|
||||
core go fmt --fix # Fix formatting
|
||||
core go fmt --diff # Show diff
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,14 +1,15 @@
|
|||
# core go
|
||||
|
||||
Go development tools.
|
||||
Go development tools with enhanced output and environment setup.
|
||||
|
||||
## Subcommands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| [test](test/) | Run tests |
|
||||
| [cov](cov/) | Coverage report |
|
||||
| [fmt](fmt/) | Format code |
|
||||
| [lint](lint/) | Lint code |
|
||||
| [install](install/) | Install binary |
|
||||
| [test](test/) | Run tests with coverage |
|
||||
| [cov](cov/) | Run tests with coverage report |
|
||||
| [fmt](fmt/) | Format Go code |
|
||||
| [lint](lint/) | Run golangci-lint |
|
||||
| [install](install/) | Install Go binary |
|
||||
| [mod](mod/) | Module management |
|
||||
| [work](work/) | Workspace management |
|
||||
|
|
|
|||
|
|
@ -18,7 +18,8 @@ core go install [path] [flags]
|
|||
## Examples
|
||||
|
||||
```bash
|
||||
core go install # Auto-detect cmd/
|
||||
core go install ./cmd/core # Specific path
|
||||
core go install --no-cgo # Pure Go
|
||||
core go install # Install current module
|
||||
core go install ./cmd/core # Install specific path
|
||||
core go install --no-cgo # Pure Go (no C dependencies)
|
||||
core go install -v # Verbose output
|
||||
```
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ core go lint [flags]
|
|||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--fix` | Auto-fix issues |
|
||||
| `--fix` | Fix issues automatically |
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@ Module management.
|
|||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `tidy` | Tidy go.mod |
|
||||
| `download` | Download dependencies |
|
||||
| `tidy` | Add missing and remove unused modules |
|
||||
| `download` | Download modules to local cache |
|
||||
| `verify` | Verify dependencies |
|
||||
| `graph` | Show dependency graph |
|
||||
| `graph` | Print module dependency graph |
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -13,11 +13,11 @@ core go test [flags]
|
|||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--pkg` | Package to test (default: `./...`) |
|
||||
| `--run` | Run specific tests |
|
||||
| `--short` | Skip long-running tests |
|
||||
| `--race` | Enable race detection |
|
||||
| `--coverage` | Show coverage summary |
|
||||
| `--json` | JSON output for CI |
|
||||
| `--run` | Run only tests matching regexp |
|
||||
| `--short` | Run only short tests |
|
||||
| `--race` | Enable race detector |
|
||||
| `--coverage` | Show detailed per-package coverage |
|
||||
| `--json` | Output JSON results |
|
||||
| `-v` | Verbose output |
|
||||
|
||||
## Examples
|
||||
|
|
|
|||
19
docs/cmd/go/work/index.md
Normal file
19
docs/cmd/go/work/index.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# core go work
|
||||
|
||||
Go workspace management commands.
|
||||
|
||||
## Subcommands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `sync` | Sync go.work with modules |
|
||||
| `init` | Initialize go.work |
|
||||
| `use` | Add module to workspace |
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
core go work sync # Sync workspace
|
||||
core go work init # Initialize workspace
|
||||
core go work use ./pkg/mymodule # Add module to workspace
|
||||
```
|
||||
Loading…
Add table
Reference in a new issue