From 13561b1de6c159b9c25717ee1011071f6232ff12 Mon Sep 17 00:00:00 2001 From: Snider Date: Thu, 29 Jan 2026 15:46:24 +0000 Subject: [PATCH] docs: fix command prefixes across documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - core search → core pkg search - core install → core pkg install - core templates → core vm templates - core run → core vm run - --target → --output in docs sync Co-Authored-By: Claude Opus 4.5 --- docs/cmd/docs/example.md | 2 +- docs/cmd/pkg/search/index.md | 30 +++++++++++++++--------------- docs/cmd/vm/templates/index.md | 12 ++++++------ 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/cmd/docs/example.md b/docs/cmd/docs/example.md index 706615ba..77299708 100644 --- a/docs/cmd/docs/example.md +++ b/docs/cmd/docs/example.md @@ -10,5 +10,5 @@ core docs list ```bash core docs sync -core docs sync --target ./docs +core docs sync --output ./docs ``` diff --git a/docs/cmd/pkg/search/index.md b/docs/cmd/pkg/search/index.md index 7666ea17..0b923a55 100644 --- a/docs/cmd/pkg/search/index.md +++ b/docs/cmd/pkg/search/index.md @@ -1,13 +1,13 @@ -# core search & install +# core pkg search & core pkg install Search GitHub for repositories and install them locally. -## core search +## core pkg search Search GitHub for repositories matching a pattern. ```bash -core search [flags] +core pkg search [flags] ``` ### Flags @@ -22,16 +22,16 @@ core search [flags] ```bash # Search by pattern -core search "cli tool" +core pkg search "cli tool" # Search within organization -core search --org host-uk +core pkg search --org host-uk # Search with language filter -core search --org host-uk --language go +core pkg search --org host-uk --language go # Search all core-* repos -core search "core-" --org host-uk +core pkg search "core-" --org host-uk ``` ### Output @@ -52,12 +52,12 @@ Found 5 repositories: ★ 8 Dockerfile Updated 3 days ago ``` -## core install +## core pkg install Clone a repository from GitHub. ```bash -core install [flags] +core pkg install [flags] ``` ### Flags @@ -72,16 +72,16 @@ core install [flags] ```bash # Install by full name -core install host-uk/core +core pkg install host-uk/core # Install to specific path -core install host-uk/core --path ~/Code/host-uk +core pkg install host-uk/core --path ~/Code/host-uk # Install specific branch -core install host-uk/core --branch dev +core pkg install host-uk/core --branch dev # Shallow clone -core install host-uk/core --depth 1 +core pkg install host-uk/core --depth 1 ``` ### Authentication @@ -97,10 +97,10 @@ gh auth login # if not authenticated ```bash # Find repositories -core search --org host-uk +core pkg search --org host-uk # Install one -core install host-uk/core-php --path ~/Code/host-uk +core pkg install host-uk/core-php --path ~/Code/host-uk # Check setup core doctor diff --git a/docs/cmd/vm/templates/index.md b/docs/cmd/vm/templates/index.md index a204de67..c6370e77 100644 --- a/docs/cmd/vm/templates/index.md +++ b/docs/cmd/vm/templates/index.md @@ -1,11 +1,11 @@ -# core templates +# core vm templates Manage LinuxKit templates for container images. ## Usage ```bash -core templates [command] +core vm templates [command] ``` ## Commands @@ -20,7 +20,7 @@ core templates [command] List all available LinuxKit templates. ```bash -core templates list +core vm templates list ``` ### Output @@ -46,13 +46,13 @@ Available Templates: Show details of a specific template. ```bash -core templates show +core vm templates show ``` ### Example ```bash -core templates show core-dev +core vm templates show core-dev ``` Output: @@ -108,7 +108,7 @@ services: Run with: ```bash -core run --template myserver +core vm run --template myserver ``` ## See Also