diff --git a/docs/cmd/TODO.md b/docs/cmd/TODO.md index f99f3d6..72742dc 100644 --- a/docs/cmd/TODO.md +++ b/docs/cmd/TODO.md @@ -4,11 +4,6 @@ Commands and flags found in CLI but missing from documentation. ## Missing Commands -### core build - -- `core build from-path` - Build from a local directory -- `core build pwa` - Build from a live PWA URL - ### core php - `core php packages link` - Link local packages (subcommand documentation exists but not detailed) @@ -23,27 +18,6 @@ Commands and flags found in CLI but missing from documentation. ## Missing Flags -### core build - -- `--archive` - Create archives (tar.gz for linux/darwin, zip for windows) -- `--checksum` - Generate SHA256 checksums and CHECKSUMS.txt -- `--config` - Config file path -- `--format` - Output format for linuxkit (iso-bios, qcow2-bios, raw, vmdk) -- `--push` - Push Docker image after build - -### core build sdk - -- `--dry-run` - Show what would be generated without writing files -- `--version` - Version to embed in generated SDKs - -### core build from-path - -- `--path` - The path to the static web application files - -### core build pwa - -- `--url` - The URL of the PWA to build - ### core setup - `--dry-run` - Show what would be cloned without cloning diff --git a/docs/cmd/build/index.md b/docs/cmd/build/index.md index e121bcd..9f342e9 100644 --- a/docs/cmd/build/index.md +++ b/docs/cmd/build/index.md @@ -7,6 +7,8 @@ Build Go, Wails, Docker, and LinuxKit projects with automatic project detection. | Command | Description | |---------|-------------| | [sdk](sdk/) | Generate API SDKs from OpenAPI | +| `from-path` | Build from a local directory | +| `pwa` | Build from a live PWA URL | ## Usage @@ -18,12 +20,17 @@ core build [flags] | Flag | Description | |------|-------------| -| `--type` | Project type: `go`, `wails`, `docker`, `linuxkit` (auto-detected) | +| `--type` | Project type: `go`, `wails`, `docker`, `linuxkit`, `taskfile` (auto-detected) | | `--targets` | Build targets: `linux/amd64,darwin/arm64,windows/amd64` | | `--output` | Output directory (default: `dist`) | -| `--ci` | CI mode - non-interactive, fail fast | +| `--ci` | CI mode - minimal output with JSON artifact list at the end | | `--image` | Docker image name (for docker builds) | -| `--no-sign` | Skip code signing | +| `--config` | Config file path (for linuxkit: YAML config, for docker: Dockerfile) | +| `--format` | Output format for linuxkit (iso-bios, qcow2-bios, raw, vmdk) | +| `--push` | Push Docker image after build (default: false) | +| `--archive` | Create archives (tar.gz for linux/darwin, zip for windows) - default: true | +| `--checksum` | Generate SHA256 checksums and CHECKSUMS.txt - default: true | +| `--no-sign` | Skip all code signing | | `--notarize` | Enable macOS notarization (requires Apple credentials) | ## Examples @@ -59,6 +66,9 @@ core build --type docker # With custom image name core build --type docker --image ghcr.io/myorg/myapp + +# Build and push to registry +core build --type docker --image ghcr.io/myorg/myapp --push ``` ### LinuxKit Image @@ -66,6 +76,9 @@ core build --type docker --image ghcr.io/myorg/myapp ```bash # Build LinuxKit ISO core build --type linuxkit + +# Build with specific format +core build --type linuxkit --config linuxkit.yml --format qcow2-bios ``` ## Project Detection @@ -77,6 +90,7 @@ Core automatically detects project type based on files: | `wails.json` | Wails | | `go.mod` | Go | | `Dockerfile` | Docker | +| `Taskfile.yml` | Taskfile | | `composer.json` | PHP | | `package.json` | Node | @@ -175,3 +189,21 @@ core build --notarize | `APPLE_ID` | Apple account email | | `APPLE_TEAM_ID` | Apple Developer Team ID | | `APPLE_APP_PASSWORD` | App-specific password for notarization | + +## Building from PWAs and Static Sites + +### Build from Local Directory + +Build a desktop app from static web application files: + +```bash +core build from-path --path ./dist +``` + +### Build from Live PWA + +Build a desktop app from a live Progressive Web App URL: + +```bash +core build pwa --url https://example.com +``` diff --git a/docs/cmd/build/sdk/index.md b/docs/cmd/build/sdk/index.md index d89f485..084c5ef 100644 --- a/docs/cmd/build/sdk/index.md +++ b/docs/cmd/build/sdk/index.md @@ -1,6 +1,6 @@ # core build sdk -Generate API SDKs from OpenAPI specifications. +Generate typed API clients from OpenAPI specifications. Supports TypeScript, Python, Go, and PHP. ## Usage @@ -13,9 +13,9 @@ core build sdk [flags] | Flag | Description | |------|-------------| | `--spec` | Path to OpenAPI spec file | -| `--lang` | Generate only this language | -| `--version` | Version to embed | -| `--dry-run` | Preview without generating | +| `--lang` | Generate only this language (typescript, python, go, php) | +| `--version` | Version to embed in generated SDKs | +| `--dry-run` | Show what would be generated without writing files | ## Examples