cli/docs/troubleshooting.md
Vi 4debdc1449 feat: BugSETI app, WebSocket hub, browser automation, and MCP tools (#336)
* feat: add security logging and fix framework regressions

This commit implements comprehensive security event logging and resolves critical regressions in the core framework.

Security Logging:
- Enhanced `pkg/log` with a `Security` level and helper.
- Added `log.Username()` to consistently identify the executing user.
- Instrumented GitHub CLI auth, Agentic configuration, filesystem sandbox, MCP handlers, and MCP TCP transport with security logs.
- Added `SecurityStyle` to the CLI for consistent visual representation of security events.

UniFi Security (CodeQL):
- Refactored `pkg/unifi` to remove hardcoded `InsecureSkipVerify`, resolving a high-severity alert.
- Added a `--verify-tls` flag and configuration option to control TLS verification.
- Updated command handlers to support the new verification parameter.

Framework Fixes:
- Restored original signatures for `MustServiceFor`, `Config()`, and `Display()` in `pkg/framework/core`, which had been corrupted during a merge.
- Fixed `pkg/framework/framework.go` and `pkg/framework/core/runtime_pkg.go` to match the restored signatures.
- These fixes resolve project-wide compilation errors caused by the signature mismatches.

I encountered significant blockers due to a corrupted state of the `dev` branch after a merge, which introduced breaking changes in the core framework's DI system. I had to manually reconcile these signatures with the expected usage across the codebase to restore build stability.

* feat(mcp): add RAG tools (query, ingest, collections)

Add vector database tools to the MCP server for RAG operations:
- rag_query: Search for relevant documentation using semantic similarity
- rag_ingest: Ingest files or directories into the vector database
- rag_collections: List available collections

Uses existing internal/cmd/rag exports (QueryDocs, IngestDirectory, IngestFile)
and pkg/rag for Qdrant client access. Default collection is "hostuk-docs"
with topK=5 for queries.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(mcp): add metrics tools (record, query)

Add MCP tools for recording and querying AI/security metrics events.
The metrics_record tool writes events to daily JSONL files, and the
metrics_query tool provides aggregated statistics by type, repo, and agent.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: add 'core mcp serve' command

Add CLI command to start the MCP server for AI tool integration.

- Create internal/cmd/mcpcmd package with serve subcommand
- Support --workspace flag for directory restriction
- Handle SIGINT/SIGTERM for clean shutdown
- Register in full.go build variant

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(ws): add WebSocket hub package for real-time streaming

Add pkg/ws package implementing a hub pattern for WebSocket connections:
- Hub manages client connections, broadcasts, and channel subscriptions
- Client struct represents connected WebSocket clients
- Message types: process_output, process_status, event, error, ping/pong
- Channel-based subscription system (subscribe/unsubscribe)
- SendProcessOutput and SendProcessStatus for process streaming integration
- Full test coverage including concurrency tests

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(mcp): add process management and WebSocket MCP tools

Add MCP tools for process management:
- process_start: Start a new external process
- process_stop: Gracefully stop a running process
- process_kill: Force kill a process
- process_list: List all managed processes
- process_output: Get captured process output
- process_input: Send input to process stdin

Add MCP tools for WebSocket:
- ws_start: Start WebSocket server for real-time streaming
- ws_info: Get hub statistics (clients, channels)

Update Service struct with optional process.Service and ws.Hub fields,
new WithProcessService and WithWSHub options, getter methods, and
Shutdown method for cleanup.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(webview): add browser automation package via Chrome DevTools Protocol

Add pkg/webview package for browser automation:
- webview.go: Main interface with Connect, Navigate, Click, Type, QuerySelector, Screenshot, Evaluate
- cdp.go: Chrome DevTools Protocol WebSocket client implementation
- actions.go: DOM action types (Click, Type, Hover, Scroll, etc.) and ActionSequence builder
- console.go: Console message capture and filtering with ConsoleWatcher and ExceptionWatcher
- angular.go: Angular-specific helpers for router navigation, component access, and Zone.js stability

Add MCP tools for webview:
- webview_connect/disconnect: Connection management
- webview_navigate: Page navigation
- webview_click/type/query/wait: DOM interaction
- webview_console: Console output capture
- webview_eval: JavaScript execution
- webview_screenshot: Screenshot capture

Add documentation:
- docs/mcp/angular-testing.md: Guide for Angular application testing

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: document new packages and BugSETI application

- Update CLAUDE.md with documentation for:
  - pkg/ws (WebSocket hub for real-time streaming)
  - pkg/webview (Browser automation via CDP)
  - pkg/mcp (MCP server tools: process, ws, webview)
  - BugSETI application overview
- Add comprehensive README for BugSETI with:
  - Installation and configuration guide
  - Usage workflow documentation
  - Architecture overview
  - Contributing guidelines

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(bugseti): add BugSETI system tray app with auto-update

BugSETI - Distributed Bug Fixing like SETI@home but for code

Features:
- System tray app with Wails v3
- GitHub issue fetching with label filters
- Issue queue with priority management
- AI context seeding via seed-agent-developer skill
- Automated PR submission flow
- Stats tracking and leaderboard
- Cross-platform notifications
- Self-updating with stable/beta/nightly channels

Includes:
- cmd/bugseti: Main application with Angular frontend
- internal/bugseti: Core services (fetcher, queue, seeder, submit, config, stats, notify)
- internal/bugseti/updater: Auto-update system (checker, downloader, installer)
- .github/workflows/bugseti-release.yml: CI/CD for all platforms

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: resolve import cycle and code duplication

- Remove pkg/log import from pkg/io/local to break import cycle
  (pkg/log/rotation.go imports pkg/io, creating circular dependency)
- Use stderr logging for security events in sandbox escape detection
- Remove unused sync/atomic import from core.go
- Fix duplicate LogSecurity function declarations in cli/log.go
- Update workspace/service.go Crypt() call to match interface

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: update tests for new function signatures and format code

- Update core_test.go: Config(), Display() now panic instead of returning error
- Update runtime_pkg_test.go: sr.Config() now panics instead of returning error
- Update MustServiceFor tests to use assert.Panics
- Format BugSETI, MCP tools, and webview packages with gofmt

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Snider <631881+Snider@users.noreply.github.com>
Co-authored-by: Claude <developers@lethean.io>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-05 17:22:05 +00:00

5.8 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:

  1. Check you're in the correct directory
  2. Ensure .core/build.yaml has the correct main path:
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:

  1. Update version in your code/config
  2. 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:

  1. Current directory
  2. Parent directories (walking up to root)
  3. ~/Code/host-uk/repos.yaml
  4. ~/.config/core/repos.yaml

Either:

  • Run commands from a directory with repos.yaml
  • Use --registry /path/to/repos.yaml
  • Run core setup to 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:

  1. Check you're authenticated: gh auth status
  2. Verify the repo exists and you have access
  3. For private repos, ensure your token has repo scope

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:

  1. No open issues exist
  2. Not authenticated with GitHub
  3. 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:

  1. Large number of repositories
  2. Network latency to GitHub
  3. 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

AI and Agentic Issues

"ANTHROPIC_API_KEY not set"

Cause: You're trying to use core ai or core dev commit (which uses Claude for messages) without an API key.

Fix:

export ANTHROPIC_API_KEY=sk-ant-xxxxxxxxxxxx

"failed to connect to Agentic API"

Cause: Network issues or incorrect AGENTIC_BASE_URL.

Fix:

  1. Check your internet connection
  2. If using a custom endpoint, verify AGENTIC_BASE_URL
  3. Ensure you are authenticated if required: export AGENTIC_TOKEN=xxxx

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:

  1. Check existing issues: https://github.com/host-uk/core/issues
  2. Create a new issue with:
    • Core version (core --version)
    • OS and architecture (go env GOOS GOARCH)
    • Command that failed
    • Full error output

See Also