You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(config): fix CLI command examples and clarify templates vs examples
Corrected CLI invocation syntax throughout documentation by adding the
missing 'run_sim' subcommand. The correct format is:
`python -m fusion.cli.run_sim run_sim --config_path ...`
Added comprehensive "Templates vs Examples" section to configs/README.md
explaining the distinction between generic reusable templates and
specific ready-to-run example configurations.
Changes include:
- Fix CLI command examples in cli/README.md and configs/examples/README.md
- Add "Templates vs Examples" section with comparison table and usage guidance
- Add TODO for YAML/JSON configuration file input support
- Add TODO for single entry point CLI architecture (fusion run_sim)
- Add TODO for schema system consolidation (schema.py vs schemas/*.json)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
-**Description**: The current architecture uses separate module entry points (run_sim.py, run_train.py, run_gui.py) each with their own subcommand parser, resulting in awkward invocation patterns like `python -m fusion.cli.run_sim run_sim` where "run_sim" appears twice
36
+
-**Impact**: Confusing user experience, inconsistent with modern CLI tools, harder to discover available commands
37
+
-**Proposed Solution**: Create single unified entry point with cleaner subcommand structure:
38
+
-`fusion run_sim` instead of `python -m fusion.cli.run_sim run_sim`
39
+
-`fusion train` instead of `python -m fusion.cli.run_train`
40
+
-`fusion gui` instead of `python -m fusion.cli.run_gui`
41
+
-`fusion analyze` for future analysis commands
42
+
-**Next Steps**:
43
+
1. Create main `fusion` entry point script
44
+
2. Consolidate all subcommands under single parser
45
+
3. Update setup.py/pyproject.toml with console_scripts entry point
46
+
4. Migrate existing entry points to subcommand handlers
47
+
5. Update all documentation with new invocation patterns
48
+
6. Maintain backward compatibility during transition period
0 commit comments