@capraconsulting/cals-cli 3.13.1 → 3.15.0

package/README.md

@@ -13,52 +13,61 @@ It is recommended to use `npx` over global install to ensure you
 always run the latest version. If you install it globally remember
 to update it before running.
 
-## Build
+## Commands
 
-Build and verify:
+### Authentication
 
-```sh
-$ make  # or "make build"
+Set your GitHub token (will be stored in the OS keychain):
+
+```bash
+cals auth
 ```
 
-## Contributing
+### List repositories
 
-This project uses [semantic release](https://semantic-release.gitbook.io/semantic-release/)
-to automate releases and follows
-[Git commit guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)
-from the Angular project.
+```bash
+cals repos --org capralifecycle
+cals repos --org capralifecycle --compact
+cals repos --org capralifecycle --csv
+```
+
+### List repository groups
+
+```bash
+cals groups --org capralifecycle
+```
+
+### Generate clone commands
 
-Version numbers depend on the commit type and footers: https://github.com/semantic-release/commit-analyzer/blob/75c9c87c88772d7ded4ca9614852b42519e41931/lib/default-release-rules.js#L7-L12
+Generate clone commands (pipe to bash to execute):
 
-## Goals of CLI
+```bash
+cals clone --org capralifecycle --all | bash
+cals clone --org capralifecycle mygroup | bash
+```
 
-- Provide an uniform way of consistently doing repeatable CALS tasks
-- Provide simple guidelines to improve the experience for developers
-- A tool that everybody uses and gets ownership of
-- Automate repeatable CALS tasks as we go
+### Sync repositories
 
-## Ideas and future work
+Pull latest changes for all repositories in a directory managed by a `.cals.yaml` manifest:
 
-- Automate onboarding of people
-  - Granting access to various resources: AWS, GitHub, Confluence, JIRA, Slack, ...
-- Automate offboarding of people
-- Automate generation of new projects/resources
-  - Creating GitHub repos, giving permissions etc
-  - Slack channels
-  - AWS account and structure
-  - Checklist for manual processes
-- AWS infrastructure management, e.g. scripts such as https://github.com/capralifecycle/rvr-aws-infrastructure/blob/master/rvr/create-stack.sh
-  - `cals aws ...`
+```bash
+cals sync
+cals sync --clone  # Prompt to clone missing repos
+```
 
-### Snyk management
+## Build
 
-https://snyk.docs.apiary.io/reference/projects
+Build and verify:
 
-- [ ] Automatically set up project in Snyk
-- [x] Report of which repos are in Snyk and which is not
-- [ ] Detect active vs disabled projects in Snyk (no way through API now?)
-- [x] Report issues in Snyk grouped by our projects
+```sh
+$ make  # or "make build"
+```
 
 ## Contributing
 
-This project doesn't currently accept contributions. For inquiries, please contact the maintainers at [Slack](https://liflig.slack.com/archives/C02T4KTPYS2).
+This project uses [semantic release](https://semantic-release.gitbook.io/semantic-release/)
+to automate releases and follows
+[Git commit guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)
+from the Angular project.
+
+For inquiries, please contact the maintainers at [Slack](https://liflig.slack.com/archives/C02T4KTPYS2).