CLI reference
kusaw atlas
Build and inspect the local code index
kusaw atlas
Build and inspect the local code index
Usage
kusaw atlas [flags]Flags
| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for atlas |
Subcommands
kusaw atlas build
Create an Atlas for configured repos
kusaw atlas build [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for build |
--repo | string | Build one repo label | ||
--yes | bool | false | Confirm the build without a prompt |
Example:
kusaw atlas build --factory demokusaw atlas call
Call read_map or search_code inside a step attempt
kusaw atlas call <tool> [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for call |
--json | string | JSON object of tool arguments |
Example:
kusaw atlas call read_map --json '{}'kusaw atlas install-hook
Add a notify block to the repo's git hooks
kusaw atlas install-hook [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for install-hook |
--repo | string | Repo label |
Example:
kusaw atlas install-hook --factory demo --repo apikusaw atlas refresh
Refresh an Atlas to the current local main commit
kusaw atlas refresh [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for refresh |
--repo | string | Refresh one repo label | ||
--yes | bool | false | Confirm the refresh without a prompt |
Example:
kusaw atlas refresh --factory demo --repo apikusaw atlas remove
Delete a repo's Atlas from the factory data folder
kusaw atlas remove [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for remove |
--repo | string | Repo label whose Atlas to delete | ||
--yes | bool | false | Confirm the delete without a prompt |
Example:
kusaw atlas remove --repo api --yeskusaw atlas search
Search the local Atlas index
kusaw atlas search <query> [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for search |
--json | bool | false | Print JSON | |
--kind | string | all | code, map, or all | |
--limit | int | 10 | Maximum hits (default 10, maximum 50) | |
--path | string | Limit hits to this path prefix | ||
--repo | string | Limit search to one repo label |
Example:
kusaw atlas search --factory demo --repo api "retry backoff" --jsonkusaw atlas status
Show Atlas state for each repo without starting work
kusaw atlas status [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for status |
--json | bool | false | Print JSON | |
--repo | string | Limit output to one repo label |
Example:
kusaw atlas status --factory demo --jsonkusaw atlas uninstall-hook
Remove the Atlas notify block from the repo's git hooks
kusaw atlas uninstall-hook [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for uninstall-hook |
--repo | string | Repo label |
Example:
kusaw atlas uninstall-hook --factory demo --repo apiExit codes
| Code | Name | Description |
|---|---|---|
| 0 | ok | Success. |
| 1 | error | Runtime error. |
| 2 | usage | Usage or validation error. |
| 3 | rejected | Control request rejected; the error string is printed verbatim. |
| 4 | not picked up | Control request not picked up within the wait time while serve runs. |
Example
kusaw atlas status