docs(ci): document and run capability checks
This commit is contained in:
1 parent
5c23f21586
commit
0079fe2b92
2 files changed
+19
No files matched your search
@@ -17,6 +17,8 @@ jobs:
|
|||||||
command -v pwsh >/dev/null || { echo 'pwsh is required on the Linux runner'; exit 1; }
|
command -v pwsh >/dev/null || { echo 'pwsh is required on the Linux runner'; exit 1; }
|
||||||
- name: Bash syntax
|
- name: Bash syntax
|
||||||
run: find scripts shared/hooks -name '*.sh' -print0 | xargs -0 -n1 bash -n
|
run: find scripts shared/hooks -name '*.sh' -print0 | xargs -0 -n1 bash -n
|
||||||
|
- name: Capability checks
|
||||||
|
run: ./scripts/check-capabilities.sh --skip-external
|
||||||
- name: Build
|
- name: Build
|
||||||
run: ./scripts/build.sh --summary
|
run: ./scripts/build.sh --summary
|
||||||
- name: Prompt budget
|
- name: Prompt budget
|
||||||
@@ -32,6 +34,7 @@ jobs:
|
|||||||
shell: pwsh
|
shell: pwsh
|
||||||
run: |
|
run: |
|
||||||
$env:REQUIRE_CODEX_SCHEMA = 'true'
|
$env:REQUIRE_CODEX_SCHEMA = 'true'
|
||||||
|
./scripts/check-capabilities.ps1 -SkipExternal
|
||||||
./scripts/build.ps1 -Summary
|
./scripts/build.ps1 -Summary
|
||||||
./scripts/doctor.ps1 -Summary
|
./scripts/doctor.ps1 -Summary
|
||||||
./scripts/test-shell-packages.ps1 -Summary
|
./scripts/test-shell-packages.ps1 -Summary
|
||||||
|
|||||||
@@ -11,6 +11,22 @@
|
|||||||
It keeps rules, skills, agents, hooks, and orchestration guidance in shared source files. Client adapters turn those files
|
It keeps rules, skills, agents, hooks, and orchestration guidance in shared source files. Client adapters turn those files
|
||||||
into shell-specific packages that can be inspected before they are installed.
|
into shell-specific packages that can be inspected before they are installed.
|
||||||
|
|
||||||
|
## Capability check
|
||||||
|
|
||||||
|
Check required tools, versions, repository files, and (by default) client/network access before setup. The command exits with an error when a requirement is missing. Use `--skip-external` or `-SkipExternal` only for an offline repository-only check.
|
||||||
|
|
||||||
|
PowerShell:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.\scripts\check-capabilities.ps1
|
||||||
|
```
|
||||||
|
|
||||||
|
Bash:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/check-capabilities.sh
|
||||||
|
```
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
With the [requirements](#requirements) installed, clone the repository, build it, then install it.
|
With the [requirements](#requirements) installed, clone the repository, build it, then install it.
|
||||||
|
|||||||
Reference in new issue
Block a user