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>
5.3 KiB
Troubleshooting
Common issues and how to resolve them.
Installation Issues
"command not found: core"
Cause: Go's bin directory is not in your PATH.
Fix:
# Add to ~/.bashrc or ~/.zshrc
export PATH="$PATH:$(go env GOPATH)/bin"
# Then reload
source ~/.bashrc # or ~/.zshrc
"go: module github.com/host-uk/core: no matching versions"
Cause: Go module proxy hasn't cached the latest version yet.
Fix:
# Bypass proxy
GOPROXY=direct go install github.com/host-uk/core/cmd/core@latest
Build Issues
"no Go files in..."
Cause: Core couldn't find a main package to build.
Fix:
- Check you're in the correct directory
- Ensure
.core/build.yamlhas the correctmainpath:
project:
main: ./cmd/myapp # Path to main package
"CGO_ENABLED=1 but no C compiler"
Cause: Build requires CGO but no C compiler is available.
Fix:
# Option 1: Disable CGO (if not needed)
core build # Core disables CGO by default
# Option 2: Install a C compiler
# macOS
xcode-select --install
# Ubuntu/Debian
sudo apt install build-essential
# Windows
# Install MinGW or use WSL
Build succeeds but binary doesn't run
Cause: Built for wrong architecture.
Fix:
# Check what you built
file dist/myapp-*
# Build for your current platform
core build --targets $(go env GOOS)/$(go env GOARCH)
Release Issues
"dry-run mode, use --we-are-go-for-launch to publish"
This is expected behaviour. Core runs in dry-run mode by default for safety.
To actually publish:
core ci --we-are-go-for-launch
"failed to create release: 401 Unauthorized"
Cause: GitHub token missing or invalid.
Fix:
# Authenticate with GitHub CLI
gh auth login
# Or set token directly
export GITHUB_TOKEN=ghp_xxxxxxxxxxxx
"no artifacts found in dist/"
Cause: You need to build before releasing.
Fix:
# Build first
core build
# Then release
core ci --we-are-go-for-launch
"tag already exists"
Cause: Trying to release a version that's already been released.
Fix:
- Update version in your code/config
- Or delete the existing tag (if intentional):
git tag -d v1.0.0
git push origin :refs/tags/v1.0.0
Multi-Repo Issues
"repos.yaml not found"
Cause: Core can't find the package registry.
Fix:
Core looks for repos.yaml in:
- Current directory
- Parent directories (walking up to root)
~/Code/host-uk/repos.yaml~/.config/core/repos.yaml
Either:
- Run commands from a directory with
repos.yaml - Use
--registry /path/to/repos.yaml - Run
core setupto bootstrap a new workspace
"failed to clone: Permission denied (publickey)"
Cause: SSH key not configured for GitHub.
Fix:
# Check SSH connection
ssh -T git@github.com
# If that fails, add your key
ssh-add ~/.ssh/id_ed25519
# Or configure SSH
# See: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
"repository not found" during setup
Cause: You don't have access to the repository, or it doesn't exist.
Fix:
- Check you're authenticated:
gh auth status - Verify the repo exists and you have access
- For private repos, ensure your token has
reposcope
GitHub Integration Issues
"gh: command not found"
Cause: GitHub CLI not installed.
Fix:
# macOS
brew install gh
# Ubuntu/Debian
sudo apt install gh
# Windows
winget install GitHub.cli
# Then authenticate
gh auth login
"core dev issues" shows nothing
Possible causes:
- No open issues exist
- Not authenticated with GitHub
- Not in a directory with
repos.yaml
Fix:
# Check auth
gh auth status
# Check you're in a workspace
ls repos.yaml
# Show all issues including closed
core dev issues --all
PHP Issues
"frankenphp: command not found"
Cause: FrankenPHP not installed.
Fix:
# macOS
brew install frankenphp
# Or use Docker
core php dev --docker
"core php dev" exits immediately
Cause: Usually a port conflict or missing dependency.
Fix:
# Check if port 8000 is in use
lsof -i :8000
# Try a different port
core php dev --port 9000
# Check logs for errors
core php logs
Performance Issues
Commands are slow
Possible causes:
- Large number of repositories
- Network latency to GitHub
- Go module downloads
Fix:
# For multi-repo commands, use health for quick check
core dev health # Fast summary
# Instead of
core dev work --status # Full table (slower)
# Pre-download Go modules
go mod download
Getting More Help
Enable Verbose Output
Most commands support -v or --verbose:
core build -v
core go test -v
Check Environment
core doctor
This verifies all required tools are installed and configured.
Report Issues
If you've found a bug:
- Check existing issues: https://github.com/host-uk/core/issues
- Create a new issue with:
- Core version (
core --version) - OS and architecture (
go env GOOS GOARCH) - Command that failed
- Full error output
- Core version (
See Also
- Getting Started - Installation and first steps
- Configuration - Config file reference
- doctor - Environment verification