core/php-devops
8
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

docs: expand CLAUDE.md with setup instructions and package types

Browse source 
- Add initial setup section with make commands
- Document all core CLI workflow commands with flags
- Add package types table explaining repo architecture
- Update CORE_REPO path in Makefile

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Snider 2026-01-29 21:17:04 +00:00
parent 89872c14a3
commit cd79af256c
2 changed files with 51 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
CLAUDE.md
View file

@ -1,51 +1,75 @@
# CLAUDE.md # CLAUDE.md
This file provides guidance to Claude Code when working in the developer workspace. This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## What This Is ## What This Is
This is the **developer workspace orchestrator** for Host UK. It contains: This is the **developer workspace orchestrator** for Host UK - a federated monorepo containing 18 Laravel packages. This repo contains only configuration and setup scripts; actual code lives in `packages/core-*/`, each with its own CLAUDE.md.
- `repos.yaml` - Registry of all packages
- `packages/` - Directory where repos are cloned (git-ignored)
The actual code lives in `packages/core-*/`. Each has its own CLAUDE.md. ## Initial Setup
```bash
# One-liner (macOS/Linux)
git clone git@github.com:host-uk/core-devops.git && cd core-devops && make setup
# Or step by step
make install-deps # Install go, gh, php, node, pnpm
make install-core # Build/install core CLI to ~/.local/bin
make clone # Clone all repos into packages/
```
## Commands ## Commands
```bash ```bash
# Workspace setup # Environment
core setup # Clone all repos make setup # Full setup (deps + core + clone)
core doctor # Check environment core doctor # Check environment (requires: git, gh, php 8.3+, composer, node 20+, pnpm)
core doctor --fix # Attempt to fix issues
# Multi-repo operations # Multi-repo workflow
core health # Quick status core health # Quick status summary
core work # Full workflow core work # Full workflow: status → commit → push
core commit # Claude-assisted commits core work --status # Status table only (no commit/push)
core push # Push changes core commit # Claude-assisted commits for dirty repos
core pull # Pull updates core commit --all # Commit all without prompting
core push # Push repos with unpushed commits
core pull # Pull repos that are behind
# GitHub integration # GitHub integration (requires gh CLI)
core issues # List issues core issues # List open issues across repos
core reviews # List PRs core issues --assignee @me
core ci # CI status core reviews # List PRs with review status
core ci # GitHub Actions workflow status
# Analysis # Analysis
core impact core-php # Dependency analysis core impact core-php # Show what depends on core-php
``` ```
## Working on Packages ## Working on Packages
```bash ```bash
cd packages/core-php cd packages/core-php
composer test # Run tests composer install
composer lint # Fix style composer test # Run Pest tests
composer lint # Fix code style (Pint)
npm run dev # Vite dev server (if has frontend)
``` ```
## Package Types (repos.yaml)
| Type | Examples | Purpose |
|------|----------|---------|
| foundation | core-php | Base framework (no dependencies) |
| module | core-tenant, core-admin, core-api, core-mcp | Infrastructure services |
| product | core-bio, core-social, core-analytics | User-facing applications |
| template | core-template | Starter for new projects |
| meta | core-devops | This workspace repo |
## This Is a Workspace, Not Code ## This Is a Workspace, Not Code
Don't add code here. This repo only contains: Don't add code here. All actual development happens in `packages/core-*/`.
- Configuration files
- The `packages/` directory structure
- Documentation
All actual development happens in `packages/core-*/`. This repo manages:
- `repos.yaml` - Package registry with dependencies
- `packages/` - Cloned repositories (git-ignored)
- `scripts/` - Setup scripts for macOS/Linux/Windows

2
Makefile
View file

@ -1,7 +1,7 @@
# Host UK Developer Workspace # Host UK Developer Workspace
# Run `make setup` to bootstrap your environment # Run `make setup` to bootstrap your environment
CORE_REPO := github.com/Snider/Core CORE_REPO := github.com/host-uk/core
CORE_VERSION := latest CORE_VERSION := latest
INSTALL_DIR := $(HOME)/.local/bin INSTALL_DIR := $(HOME)/.local/bin