654f8df1ad
New documentation: - getting-started.md: installation, first build, first release - troubleshooting.md: common errors and fixes - workflows.md: end-to-end task sequences - glossary.md: term definitions - migration.md: upgrading from legacy tools Fixes: - Command examples: core dev task* → core ai task* - CI flag: --were-go-for-launch → --we-are-go-for-launch - Setup commands: core health → core dev health - Installation: circular core go install reference - Cross-references: broken fragment links Improvements: - Added complete repos.yaml documentation - Added comprehensive environment variables reference - Added multiple installation methods (go install, binary, source) - Moved TODO.md to docs/.internal/ Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2.8 KiB
2.8 KiB
Core CLI
Core is a unified CLI for the host-uk ecosystem - build, release, and deploy Go, Wails, PHP, and container workloads.
Installation
# Via Go (recommended)
go install github.com/host-uk/core/cmd/core@latest
# Or download binary from releases
curl -Lo core https://github.com/host-uk/core/releases/latest/download/core-$(go env GOOS)-$(go env GOARCH)
chmod +x core && sudo mv core /usr/local/bin/
# Verify
core doctor
See Getting Started for all installation options including building from source.
Command Reference
See cmd/ for full command documentation.
| Command | Description |
|---|---|
| go | Go development (test, fmt, lint, cov) |
| php | Laravel/PHP development |
| build | Build Go, Wails, Docker, LinuxKit projects |
| ci | Publish releases (dry-run by default) |
| sdk | SDK generation and validation |
| dev | Multi-repo workflow + dev environment |
| pkg | Package search and install |
| vm | LinuxKit VM management |
| docs | Documentation management |
| setup | Clone repos from registry |
| doctor | Check development environment |
Quick Start
# Go development
core go test # Run tests
core go test --coverage # With coverage
core go fmt # Format code
core go lint # Lint code
# Build
core build # Auto-detect and build
core build --targets linux/amd64,darwin/arm64
# Release (dry-run by default)
core ci # Preview release
core ci --we-are-go-for-launch # Actually publish
# Multi-repo workflow
core dev work # Status + commit + push
core dev work --status # Just show status
# PHP development
core php dev # Start dev environment
core php test # Run tests
Configuration
Core uses .core/ directory for project configuration:
.core/
├── release.yaml # Release targets and settings
├── build.yaml # Build configuration (optional)
└── linuxkit/ # LinuxKit templates
And repos.yaml in workspace root for multi-repo management.
Guides
- Getting Started - Installation and first steps
- Workflows - Common task sequences
- Troubleshooting - When things go wrong
- Migration - Moving from legacy tools
Reference
- Configuration - All config options
- Glossary - Term definitions
Claude Code Skill
Install the skill to teach Claude Code how to use the Core CLI:
curl -fsSL https://raw.githubusercontent.com/host-uk/core/main/.claude/skills/core/install.sh | bash
See skill/ for details.