Skip to content

Commit 6a3b6c0

Browse files
committed
Updated for current state
1 parent 308730e commit 6a3b6c0

1 file changed

Lines changed: 51 additions & 16 deletions

File tree

llms.txt

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,69 @@ Raid is written in Go, distributed as a single self-contained binary, and publis
88

99
## Docs
1010

11-
- [README](https://github.com/8bitAlex/raid/blob/main/README.md): Overview, installation, quickstart, commands reference, configuration reference, task types, best practices, comparison vs. Make/Taskfile/Just, and FAQ
11+
- [Documentation site](https://raidcli.dev): Primary documentation — guides, features, reference, and examples
12+
- [Overview](https://raidcli.dev/docs/overview): What Raid is, key concepts, and when to reach for it
13+
- [Getting started](https://raidcli.dev/docs/start): Install, create a profile, and run your first command
14+
- [README](https://github.com/8bitalex/raid/blob/main/README.md): Repo overview, installation, quickstart, full command and configuration reference, task types, best practices, comparison vs. Make/Taskfile/Just, and FAQ
1215
- [Design proposal](https://alexsalerno.dev/blog/raid-design-proposal): Rationale and design motivation for Raid
13-
- [Contributing guide](https://github.com/8bitAlex/raid/blob/main/docs/CONTRIBUTING.md): Developer setup, code style, testing, and PR workflow
16+
- [Contributing guide](https://github.com/8bitalex/raid/blob/main/docs/CONTRIBUTING.md): Developer setup, code style, testing, and PR workflow
17+
18+
## Features
19+
20+
- [Profiles](https://raidcli.dev/docs/features/profiles): Top-level `*.raid.yaml` that describes the full development environment
21+
- [Repository config](https://raidcli.dev/docs/features/repo-config): Per-repo `raid.yaml` merged into the active profile at load time
22+
- [Environments](https://raidcli.dev/docs/features/environments): Variables and tasks that switch with `raid env <name>`
23+
- [Tasks](https://raidcli.dev/docs/features/tasks): All 11 task types — Shell, Script, Set, Git, HTTP, Wait, Prompt, Confirm, Print, Template, Group
24+
- [Task groups](https://raidcli.dev/docs/features/task-groups): Reusable task sequences invoked by `ref`
25+
- [Variables](https://raidcli.dev/docs/features/variables): Variable scoping, substitution, defaults, and overrides
26+
27+
## Usage
28+
29+
- [raid install](https://raidcli.dev/docs/usage/install): Clone repositories and run install tasks across your profile
30+
- [raid env](https://raidcli.dev/docs/usage/env): Switch between development, staging, and production environments
31+
- [raid profile](https://raidcli.dev/docs/usage/profile): Add, list, switch, and remove profiles
32+
- [Custom commands](https://raidcli.dev/docs/usage/custom): Define and invoke `raid <cmd>` team workflows
33+
- [raid doctor](https://raidcli.dev/docs/usage/doctor): Diagnose profile and repo configuration issues
34+
- [raid root command](https://raidcli.dev/docs/usage/raid): Global flags and top-level invocation
35+
36+
## Reference
37+
38+
- [Commands reference](https://raidcli.dev/docs/references/commands): Every built-in and user-defined command with flags and behavior
39+
- [Schema reference](https://raidcli.dev/docs/references/schema): Profile and per-repo YAML schemas — every field, type, and default
1440

1541
## Schemas
1642

17-
- [Profile JSON Schema](https://raw.githubusercontent.com/8bitAlex/raid/main/schemas/raid-profile.schema.json): Validation schema for `*.raid.yaml` profile files
18-
- [Repository JSON Schema](https://raw.githubusercontent.com/8bitAlex/raid/main/schemas/raid-repo.schema.json): Validation schema for per-repo `raid.yaml` files
43+
- [Profile JSON Schema](https://raw.githubusercontent.com/8bitalex/raid/main/schemas/raid-profile.schema.json): Validation schema for `*.raid.yaml` profile files
44+
- [Repository JSON Schema](https://raw.githubusercontent.com/8bitalex/raid/main/schemas/raid-repo.schema.json): Validation schema for per-repo `raid.yaml` files
45+
- [Shared definitions schema](https://raw.githubusercontent.com/8bitalex/raid/main/schemas/raid-defs.schema.json): Common type definitions referenced by both schemas
1946
- [SchemaStore catalog](https://www.schemastore.org/api/json/catalog.json): Published catalog entries — auto-discovered by VS Code, JetBrains, Neovim, and other editors using the schemastore catalog
2047

2148
## Examples
2249

23-
- [Single profile example](https://github.com/8bitAlex/raid/blob/main/docs/examples/example.raid.yaml)
24-
- [Multi-profile YAML](https://github.com/8bitAlex/raid/blob/main/docs/examples/multiple-profiles.yaml)
25-
- [Multi-profile JSON](https://github.com/8bitAlex/raid/blob/main/docs/examples/multiple-profiles.json)
26-
- [Install task demo](https://github.com/8bitAlex/raid/blob/main/docs/examples/install-demo.raid.yaml)
27-
- [Environment task demo](https://github.com/8bitAlex/raid/blob/main/docs/examples/env-demo.raid.yaml)
28-
- [Per-repo raid.yaml example](https://github.com/8bitAlex/raid/blob/main/docs/examples/raid.yaml)
50+
Docsite walk-throughs:
51+
52+
- [New developer onboarding](https://raidcli.dev/docs/examples/new-developer): End-to-end first-day setup using `raid install`
53+
- [Custom commands](https://raidcli.dev/docs/examples/custom-commands): Authoring simple team `raid <cmd>` subcommands
54+
- [Advanced commands](https://raidcli.dev/docs/examples/advanced-commands): Prompts, confirms, conditional and cross-repo workflows
55+
- [Environments](https://raidcli.dev/docs/examples/environments): Switching variables and starting services per environment
56+
- [Cross-platform tasks](https://raidcli.dev/docs/examples/cross-platform): Writing tasks that work on macOS, Linux, and Windows
57+
58+
Raw YAML samples in the repo:
59+
60+
- [Single profile example](https://github.com/8bitalex/raid/blob/main/docs/examples/example.raid.yaml)
61+
- [Multi-profile YAML](https://github.com/8bitalex/raid/blob/main/docs/examples/multiple-profiles.yaml)
62+
- [Multi-profile JSON](https://github.com/8bitalex/raid/blob/main/docs/examples/multiple-profiles.json)
63+
- [Install task demo](https://github.com/8bitalex/raid/blob/main/docs/examples/install-demo.raid.yaml)
64+
- [Environment task demo](https://github.com/8bitalex/raid/blob/main/docs/examples/env-demo.raid.yaml)
65+
- [Full demo profile](https://github.com/8bitalex/raid/blob/main/docs/examples/demo.raid.yaml)
66+
- [Per-repo raid.yaml example](https://github.com/8bitalex/raid/blob/main/docs/examples/raid.yaml)
2967

3068
## Installation
3169

32-
- [install.sh](https://github.com/8bitAlex/raid/blob/main/install.sh): Linux installer — `curl -fsSL https://raw.githubusercontent.com/8bitalex/raid/main/install.sh | bash`
70+
- [install.sh](https://github.com/8bitalex/raid/blob/main/install.sh): Linux/macOS installer — `curl -fsSL https://raw.githubusercontent.com/8bitalex/raid/main/install.sh | bash`
3371
- [Homebrew tap](https://github.com/8bitalex/homebrew-tap): macOS — `brew install 8bitalex/tap/raid`
34-
- [Releases](https://github.com/8bitAlex/raid/releases): Prebuilt binaries for macOS, Linux, and Windows (amd64 and arm64)
72+
- [Releases](https://github.com/8bitalex/raid/releases): Prebuilt binaries for macOS, Linux, and Windows (amd64 and arm64)
3573

3674
## Optional
3775

38-
- [Task reference](https://github.com/8bitAlex/raid/blob/main/README.md#tasks): All 11 task types — Shell, Script, Set, Git, HTTP, Wait, Prompt, Confirm, Print, Template, Group
39-
- [Commands configuration](https://github.com/8bitAlex/raid/blob/main/README.md#commands-configuration): Defining custom `raid <cmd>` subcommands in profiles and per-repo configs
40-
- [Best practices](https://github.com/8bitAlex/raid/blob/main/README.md#best-practices): Committing `raid.yaml` to every repo, gating destructive tasks with `Confirm`, organizing profiles, keeping secrets out of config
41-
- [License (GPL-3.0)](https://github.com/8bitAlex/raid/blob/main/LICENSE)
76+
- [License (GPL-3.0)](https://github.com/8bitalex/raid/blob/main/LICENSE)

0 commit comments

Comments
 (0)