gcloud-help/README.md

# `gcloud help`

[![crawl](https://github.com/imjasonh/gcloud-help/actions/workflows/crawl.yaml/badge.svg)](https://github.com/imjasonh/gcloud-help/actions/workflows/crawl.yaml)

This repo automatically scrapes the help text for [`gcloud`](https://cloud.google.com/sdk/) and puts it in this Git repo.

Scraping is automated with GitHub Actions.
Every day, the workflow installs the latest `gcloud` release, and crawls the output of `gcloud help` and all subgroups and subcommands.
The output is placed in [the `gcloud/` directory](./gcloud/).

This produces the same content as the [official CLI reference](https://cloud.google.com/sdk/gcloud/reference), in text form, with history.
This enables diffing the help text of two `gcloud` releases.

## How is this useful?

You can use this repo to identify changes in `gcloud` releases.

For example, compare [`374.0.0` and `375.0.0`](https://github.com/imjasonh/gcloud-help/compare/374.0.0..375.0.0) (looks like lots of help text formatting...).

GitHub also provides an undocumented RSS feed feature, which even lets you filter changes in certain paths.
For example, you can subscribe to [changes to the `gcloud builds` surface](https://github.com/imjasonh/gcloud-help/commits/main.atom?path=gcloud/builds) in your RSS reader of choice.
Party like it's 2009!

Using this information you can count the number of unique CLI surfaces provided by `gcloud`:

```
$ find gcloud -type f | wc -l
    9816
```

Or find the longest CLI surface:

```
$ find gcloud -type f | awk '{print length, $0}' | sort -rn | head -10 | sed -e "s+/+ +g"
81 gcloud alpha compute instance-groups managed rolling-action stop-proactive-update
80 gcloud beta compute instance-groups managed rolling-action stop-proactive-update
79 gcloud alpha compute resource-policies create vm-maintenance maintenance-window
78 gcloud alpha compute resource-policies create vm-maintenance concurrency-limit
76 gcloud alpha compute public-delegated-prefixes delegated-sub-prefixes delete
76 gcloud alpha compute public-delegated-prefixes delegated-sub-prefixes create
75 gcloud compute instance-groups managed rolling-action stop-proactive-update
75 gcloud beta compute public-delegated-prefixes delegated-sub-prefixes delete
75 gcloud beta compute public-delegated-prefixes delegated-sub-prefixes create
74 gcloud alpha metastore services databases tables remove-iam-policy-binding
```

---

All text content is owned by Google, licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).

Code in the repo is owned by me, licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
add readme, schedule workflow, tag stuff 2022-03-01 08:47:52 -05:00			# `gcloud help`

add badge 2022-03-01 16:55:47 -05:00			`[![crawl](https://github.com/imjasonh/gcloud-help/actions/workflows/crawl.yaml/badge.svg)](https://github.com/imjasonh/gcloud-help/actions/workflows/crawl.yaml)`

add readme, schedule workflow, tag stuff 2022-03-01 08:47:52 -05:00			This repo automatically scrapes the help text for [`gcloud`](https://cloud.google.com/sdk/) and puts it in this Git repo.

			`Scraping is automated with GitHub Actions.`
			Every day, the workflow installs the latest `gcloud` release, and crawls the output of `gcloud help` and all subgroups and subcommands.
			The output is placed in [the `gcloud/` directory](./gcloud/).

			`This produces the same content as the [official CLI reference](https://cloud.google.com/sdk/gcloud/reference), in text form, with history.`
			This enables diffing the help text of two `gcloud` releases.

Document tag diffs, RSS feeds 2022-03-01 16:53:19 -05:00			`## How is this useful?`

			You can use this repo to identify changes in `gcloud` releases.

			For example, compare [`374.0.0` and `375.0.0`](https://github.com/imjasonh/gcloud-help/compare/374.0.0..375.0.0) (looks like lots of help text formatting...).

			`GitHub also provides an undocumented RSS feed feature, which even lets you filter changes in certain paths.`
			For example, you can subscribe to [changes to the `gcloud builds` surface](https://github.com/imjasonh/gcloud-help/commits/main.atom?path=gcloud/builds) in your RSS reader of choice.
			`Party like it's 2009!`

add some more examples 2022-03-05 16:03:05 -05:00			Using this information you can count the number of unique CLI surfaces provided by `gcloud`:

			```
			`$ find gcloud -type f \| wc -l`
			`9816`
			```

			`Or find the longest CLI surface:`

			```
			`$ find gcloud -type f \| awk '{print length, $0}' \| sort -rn \| head -10 \| sed -e "s+/+ +g"`
			`81 gcloud alpha compute instance-groups managed rolling-action stop-proactive-update`
			`80 gcloud beta compute instance-groups managed rolling-action stop-proactive-update`
			`79 gcloud alpha compute resource-policies create vm-maintenance maintenance-window`
			`78 gcloud alpha compute resource-policies create vm-maintenance concurrency-limit`
			`76 gcloud alpha compute public-delegated-prefixes delegated-sub-prefixes delete`
			`76 gcloud alpha compute public-delegated-prefixes delegated-sub-prefixes create`
			`75 gcloud compute instance-groups managed rolling-action stop-proactive-update`
			`75 gcloud beta compute public-delegated-prefixes delegated-sub-prefixes delete`
			`75 gcloud beta compute public-delegated-prefixes delegated-sub-prefixes create`
			`74 gcloud alpha metastore services databases tables remove-iam-policy-binding`
			```

add readme, schedule workflow, tag stuff 2022-03-01 08:47:52 -05:00			`---`

			`All text content is owned by Google, licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).`

			`Code in the repo is owned by me, licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).`