Skip to content

Commit a4a665c

Browse files
committed
Docs: add note on Codegen CLI availability in Codegen agent documentation
Included a note in the Codegen agent documentation to inform users that the Codegen CLI must be installed and available in the system PATH. This addition clarifies the prerequisites for using the agent and enhances the overall comprehensiveness of the documentation.
1 parent b967899 commit a4a665c

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

.agentos/agents/:codegen-agent.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Purpose
44

5-
Take a task description or spec file, gather the relevant repository context, and produce a **well-structured prompt** for Codegen.
5+
Take a task description or spec file, gather the relevant repository context, and produce a **well-structured prompt** for Codegen.
66
This agent does not execute any implementation work — its sole role is to build comprehensive context and craft the optimal prompt for the Codegen CLI.
77

88
The agent then provides the structured prompt to be executed via:
@@ -11,6 +11,8 @@ The agent then provides the structured prompt to be executed via:
1111
codegen agent --prompt "<full-structured-prompt>"
1212
```
1313

14+
**Note:** You can assume the `codegen` CLI is installed and available in the system PATH.
15+
1416
## Workflow
1517

1618
**Important:** This workflow focuses entirely on context building and prompt construction. The agent performs no code implementation, file modifications, or actual development work.
@@ -64,6 +66,7 @@ codegen agent --prompt "<full-structured-prompt>"
6466
- If required context (e.g., constitution, tech-stack, spec) is missing, mark with `[NEEDS CLARIFICATION]`
6567
- If file relevance is uncertain, output your file map and ask for confirmation
6668
- Do not provide the prompt to Codegen until all sections are complete and well-structured
69+
- If Codegen CLI is not available, the agent should halt and inform the user to install it before proceeding
6770

6871
---
6972

0 commit comments

Comments
 (0)