docs(questions): add Followup 2025-17-09-14:21 with targeted clarifications
This commit is contained in:
@@ -89,3 +89,38 @@ I want to clearly state that this repo is AGPLv3 (code/prompts) but NOT anything
|
|||||||
17. Supported OS/shells: Target bash/zsh on macOS/Linux, anything else?
|
17. Supported OS/shells: Target bash/zsh on macOS/Linux, anything else?
|
||||||
|
|
||||||
Lets say Ubuntu 22.04/Debian 12 or later.
|
Lets say Ubuntu 22.04/Debian 12 or later.
|
||||||
|
|
||||||
|
## Followup 2025-17-09-14:21
|
||||||
|
|
||||||
|
### Wrapper naming & install
|
||||||
|
1. Wrapper name: prefer `codex-helper` or `CodexHelper`? Install path (e.g., `~/bin`)?
|
||||||
|
2. Binary discovery: try `which codex` first, then `codex-cli`? Allow override via `CODEX_BIN` env var?
|
||||||
|
|
||||||
|
### Modes and templates
|
||||||
|
3. Repo layout: store modes under `modes/<name>/` with `system.md`, `mode.md`, `defaults.yaml`? OK?
|
||||||
|
4. Project scaffolding: create templates under `templates/project/<mode>/...` and generate into user-specified target path? OK?
|
||||||
|
5. Example project: include only one example (resume rewriter). Where should we place the example template in this repo?
|
||||||
|
|
||||||
|
### Project structure & config
|
||||||
|
6. Config format: YAML vs JSON vs TOML? Preference? (YAML easier for markdown-heavy prompts.)
|
||||||
|
7. Single file vs split: prefer `project.yaml` in project root, or split into `prompts/` + `codex.yaml`?
|
||||||
|
8. Precedence confirm: CLI > env > project > mode > global defaults — confirm this exact order?
|
||||||
|
9. Entrypoint script: generate `codex.sh` in project root that resolves config and runs `codex`? Name OK?
|
||||||
|
|
||||||
|
### CLI UX
|
||||||
|
10. Subcommands: propose `new-project`, `new-mode`, and `run`. Example:
|
||||||
|
- `codex-helper new-project --mode SAASApp --name my-app --path ~/dev/my-app`
|
||||||
|
- `codex-helper new-mode --name SAASApp`
|
||||||
|
- `codex-helper run` (inside a project dir)
|
||||||
|
Approve?
|
||||||
|
11. Flags: always accept `--mode`, `--prompt-file`, `--config`, `--sandbox`, `--full-auto` to pass through to codex. Anything else?
|
||||||
|
12. Non-interactive default: default non-interactive; add `--interactive` to prompt for missing values. Approve?
|
||||||
|
|
||||||
|
### Outputs, safety, and licensing
|
||||||
|
13. Runs directory: write transcripts/logs to `<project>/runs/<timestamp>/...`. Approve?
|
||||||
|
14. Safety: default to no destructive actions; require `--force` to overwrite existing files; never run `git push` for user projects. Approve and add anything else?
|
||||||
|
15. Dependencies: are `bash`, `git`, and one of `jq` (JSON) or `yq` (YAML) acceptable? Preference?
|
||||||
|
16. Licensing in generated projects: include no default LICENSE, or include a template with TODO? Preference?
|
||||||
|
|
||||||
|
### Roadmap
|
||||||
|
17. We will add `docs/ROADMAP.md` and defer MCP integration. Any additional roadmap items you want listed now?
|
||||||
|
Reference in New Issue
Block a user