cli/docs/index.md
Snider d112dab0d1 docs: reorganize into docs/cmd/ and add missing commands
- Move command docs to docs/cmd/ for better organization
- Add work.md: multi-repo operations (health, issues, reviews, etc.)
- Add docs.md: documentation management (list, sync)
- Add templates.md: LinuxKit template management
- Add setup.md: clone repos from registry
- Update index.md with full command reference

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-29 09:44:28 +00:00

3.7 KiB

Core CLI

Core is a unified CLI for the host-uk ecosystem - build, release, and deploy Go, Wails, PHP, and container workloads.

Installation

# Go install
go install github.com/host-uk/core/cmd/core@latest

# Or download from releases
curl -fsSL https://github.com/host-uk/core/releases/latest/download/core-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/amd64/').tar.gz | tar -xzf - -C /usr/local/bin

Commands

Build & Release

Command Description
core build Build Go, Wails, Docker, and LinuxKit projects
core release Build and publish to GitHub, npm, Homebrew, etc.
core sdk Generate and manage API SDKs

Containers

Command Description
core run Run LinuxKit images with qemu/hyperkit
core ps List running containers
core stop Stop running containers
core logs View container logs
core exec Execute commands in containers
core templates Manage LinuxKit templates

Development

Command Description
core dev Portable development environment (100+ tools)
core php Laravel/PHP development tools
core doctor Check development environment

GitHub & Multi-Repo

Command Description
core search Search GitHub for repositories
core install Clone a repository from GitHub
core setup Clone all repos from registry
core work Multi-repo git operations
core health Quick health check across repos
core issues List open issues across repos
core reviews List PRs needing review
core ci Check CI status across repos

Documentation

Command Description
core docs Documentation management

Quick Start

# Build a Go project
core build

# Build for specific targets
core build --targets linux/amd64,darwin/arm64

# Release to GitHub
core release

# Release to multiple package managers
core release  # Publishes to all configured targets

# Start PHP dev environment
core php dev

# Run a LinuxKit image
core run server.iso

Configuration

Core uses .core/ directory for project configuration:

.core/
├── release.yaml    # Release targets and settings
├── build.yaml      # Build configuration (optional)
└── linuxkit/       # LinuxKit templates
    └── server.yml

Documentation

Command Reference

  • Build - Cross-platform builds with code signing
  • Release - Publishing to package managers
  • SDK - Generate API clients from OpenAPI
  • Run - Container management
  • Templates - LinuxKit templates
  • Dev - Portable development environment
  • PHP - Laravel development
  • Doctor - Environment check
  • Search & Install - GitHub integration
  • Setup - Clone repos from registry
  • Work - Multi-repo operations
  • Docs - Documentation management

Reference

Framework

Core also provides a Go framework for building desktop applications: