The OpenCLI specification (OCS) defines a standard, platform and language agnostic interface to CLI applications which allows both humans and computers to understand how a CLI tool should be invoked without access to source code or documentation.
- Create documentation for CLI tools
- Generate clients for interacting with CLI tools
- Automate external tools such as MCP servers
- Detect changes in CLI APIs
The OpenCLI specification is currently a draft, and we need discussions with the community to make sure that the first version can be as good as possible.
Head over to our discussions if you have feedback or ideas!
We're using Cake to build the OpenCLI JSON schema, and site.
For this you will need to have the .NET 9.0 SDK installed which you can find over at https://dotnet.microsoft.com/en-us/download.
After installing the .NET SDK, make sure that you've restored Cake by running the following in the repository root:
$ dotnet tool restoreAfter that, running the build is as easy as writing:
$ dotnet make