riverma
commented
2 months ago Here's a proposed usage statement of an idea that came about through discussion with @ingyhere on having a "SLIM CLI" tool for self-service purposes:
Usage: slim-cli [OPTIONS] COMMAND [ARGS]...
This tool automates the application of best practices to git repositories.
Options:
-h, --help Show this help message and exit.
-d, --dry-run Generate a dry-run plan of activities to be performed.
Commands:
list Lists all available best practice from the SLIM.
repos Initialize / list git repositories from a file or a single repository from the command line.
Usage: slim-cli repos add [FILE_PATH | REPO_URL]
Usage: slim-cli repos remove REPO_URL
Usage: slim-cli repos list
apply Applies a chosen best practice to a new git branch in the loaded repositories.
Usage: slim-cli apply [OPTIONS] BEST_PRACTICE_ID [--use-ai]
deploy Pushes the new branch to the remote and creates a pull request.
Usage: slim-cli deploy [OPTIONS] BRANCH_NAME
apply-deploy Automatically applies a best practice, pushes the new branch, and files a PR.
Usage: slim-cli apply-deploy [OPTIONS] BEST_PRACTICE_ID [--auto-customize]
Options for 'apply' and 'apply-deploy':
--use-ai Enables an intelligent system to customize the best practice for each repository
Examples:
# List all available best practices
$ slim-cli list
ID. NAME DESCRIPTION
SLIM-123 README A template that can be used to help developers and users understand your repository's project code concisely and clearly.
# Load repositories from a file
$ slim-cli repos add /path/to/repo_list.txt
Loaded repo 1
Loaded repo 2
# Load a single repository
$ slim-cli repos add https://github.com/myorg/myrepo
Loaded repo myrepo
# List loaded repositories
$ slim-cli repos list
https://github.com/myorg/myrepo
https://github.com/myorg/repo1
https://github.com/myorg/repo2
# Remove repositories
$ slim-cli repos remove https://github.com/myorg/myrepo
Removed https://github.com/myorg/myrepo
# Apply a best practice to repositories loaded from 'repo_list.txt'
$ slim-cli apply SLIM-123 --use-ai
AI features enabled
Applied best practice SLIM-123 into git branch slim-123 in repo 1
Applied best practice SLIM-123 into git branch slim-123 in repo 2
# Push the branch 'feature-branch' to remote and create a PR
$ slim-cli deploy slim-readme-pr
AI features enabled
Pushed branch slim-123 to repo 1 as a pr https://.../path/to/pr
# Automatically apply best practice 123 with customization to loaded repositories and handle PR
$ slim-cli apply-deploy SLIM-123 --use-ai
AI features enabled
Applied best practice SLIM-123 into git branch
Pushed branch slim-123 to repo 1 as a pr https://.../path/to/pr
yunks128
stirlingalgermissen
Checked for duplicates
Yes - I've already checked
Alternatives considered
Yes - and alternatives don't suffice
Related problems
Our "standards-as-code" infusion process is a big innovation in how we infuse best practices into projects. However, it could be improved through better documentation and tools.
Specifically: (for docs) its not really clear for end-users or developers about how this really works and how to engage with it, and (tools) an end-user is not able to infuse easily themselves.
Describe the feature request
The proposed feature would satisfy the following: