go/docs/index.md
Snider 229cde534d docs: add comprehensive CLI documentation
- Add sdk.md: SDK generation and API diff commands
- Add dev.md: DevOps portable environment (100+ tools)
- Add doctor.md: Environment health check
- Add search.md: GitHub search and install commands
- Update build.md: Add code signing flags (--no-sign, --notarize)
- Update release.md: Add --target sdk flag
- Update index.md: Organize commands by category

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

2.9 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 Integration

Command Description
core search Search GitHub for repositories
core install Clone a repository from GitHub
core setup Clone all repos from registry

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

Build & Release

Containers

Development

Reference

Framework

Core also provides a Go framework for building desktop applications: