https://github.com/rwxrob/register-cmdbox
🍱 Register your CmdBox command modules or peruse the manifest
https://github.com/rwxrob/register-cmdbox
Last synced: 8 months ago
JSON representation
🍱 Register your CmdBox command modules or peruse the manifest
- Host: GitHub
- URL: https://github.com/rwxrob/register-cmdbox
- Owner: rwxrob
- Created: 2021-06-23T14:46:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-23T17:40:14.000Z (over 4 years ago)
- Last Synced: 2024-10-26T00:03:47.712Z (about 1 year ago)
- Language: HTML
- Homepage: https://cmdbox.sh
- Size: 4.88 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🍱 CmdBox Central Command Register
Here's where you explicitly publish your CmdBox command module to the
world. For now, you can simply add your command module to the
[manifest](manifest) and submit a PR. That's it. We'll do the rest.
Everything about your module can be derived from it. The GitHub PR
process allows moderators to make sure only working, current command
modules make it into the list.
Do *not* submit placeholders or unfinished modules. Simple and silly
modules are fine. Unfinished ones are not. Abuse of this project policy
could result in blacklisting and automatic PR and detection rejection.
## Simple Space-Delimited Manifest
The plan is to follow a GitOps approach and make the
[`manifest`](manifest) file the authoritative source for all registered
or discovered command modules. (Even 10k entries would be under one
MiB.) This file can also be fetched directly (and always will be
available) from `cmdbox.sh/manifest`.
```
curl -LO cmdbox.sh/manifest
```
The `manifest` is a simple single-space-delimited table file with the
first field the name of the command and the second the Go-importable
URL. Developers are encouraged to implement caching into whatever tools
they create that fetch this file (which is only updated once a day).
## Monitored Git Hosting Providers
Eventually, this project will contain the code for automatically
discovering command modules by looking for anything beginning with
`cmdbox-` hosted on any of the monitored Git providers. Here are the git
hosts we plan to monitor (open an issue if we missed one):
Provider|URL
:-:|-
GitHub|
GitLab|
Sourcehut|
Bitbucket|
Note that when discovery is working the need for PRs will be diminished
but not removed. Some projects may choose to not follow the `cmdbox-*`
convention or be hosted on services where detection is not currently
supported.