Consider sub-commands for the watchmaker cli
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 42
- Forks
- 31
- Avg merge
- 5h 22m
- Merged PRs (30d)
- 19
Description
Right now, running watchmaker will immediately start executing. A safer default would be just to print the help. The current functionality could be implemented behind a sub-command, instead, e.g. watchmaker run. This would be introduced without changing the current behavior, just implementing the sub-command(s) and printing a deprecation warning when invoked without a sub-command.
Some sub-command ideas...
init- Copy config file to /etc/watchmaker.yaml or /etc/watchmaker/config.yamlinstall- Invoke aninstallmethod from workers in the config, intended to install the config mgmt pkgsrun- Invoke therunmethod from workers, intended to run the config mgmt toolclean- Invoke thecleanmethod from workers, intended to remove config mgmt pkgs (not any hardening applied by the tool)worker- Run a specific worker from the config
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the watchmaker CLI entry point and reviewing how the current no-subcommand invocation dispatches work. Define the intended subcommands and their behavior from the issue, then verify that the existing invocation remains functional while printing help for the safer default and a deprecation warning where required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100