Skip to content

Document extends Command #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
boblail wants to merge 1 commit into from
Closed

Document extends Command #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions draft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenCLI Specification

Version 0.1
Version 0.2

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
Expand All @@ -13,6 +13,7 @@ This document is licensed under the MIT license

| Date | Author | Description |
|------|--------|-------------|
| 2026-01-16 | Bob Lail | **BREAKING**: [Document Object](#document-object) now extends [Command Object](#command-object); add `summary` to [Command Object](#command-object); remove `title` and `description` from [CliInfo Object](#cliinfo-object) |
| 2025-07-15 | Patrik Svensson | Added `interactive` to root command and commands |
| 2025-07-16 | Patrik Svensson | Added [Metadata Object](#metadata-object) |
| 2025-07-16 | Patrik Svensson | Changed maps to arrays |
Expand Down Expand Up @@ -96,13 +97,18 @@ This text is the only normative description of the format.

#### Document Object

This is the root object of the OpenCLI Description.
This is the root object of the OpenCLI Description. It extends the [Command Object](#command-object) and inherits all of its fields.

| Field Name | Type | Default Value | Description |
|------------|:----:|---------------|-------------|
| opencli | `string` | - | **REQUIRED** The OpenCLI version number |
| info | [CliInfo Object](#cliinfo-object) | - | **REQUIRED** Information about the CLI |
| conventions | [Conventions Object](#conventions-object) | - | The conventions used by the CLI |
| name | `string` | - | **REQUIRED** The CLI name |
| summary | `string` | - | A short summary of the CLI |
| description | `string` | - | A description of the CLI |
| aliases | [`string`] | - | The CLI aliases |
| hidden | `bool` | `false` | Whether or not the CLI is hidden |
| arguments | [[Argument Object](#argument-object)] | - | Root command arguments |
| options | [[Option Object](#option-object)] | - | Root command options |
| commands | [[Command Object](#command-object)] | - | Root command sub commands |
Expand All @@ -115,9 +121,6 @@ This is the root object of the OpenCLI Description.

| Field Name | Type | Default Value | Description |
|------------|:----:|---------------|-------------|
| title | `string` | - | **REQUIRED** The application title |
| summary | `string` | - | A short summary of the application |
| description | `string` | - | A description of the application |
| contact | [Contact Object](#contact-object) | - | The contact information |
| license | [License Object](#license-object) | - | The application license |
| version | `string` | - | **REQUIRED** The application version |
Expand Down Expand Up @@ -150,6 +153,7 @@ This is the root object of the OpenCLI Description.
| Field Name | Type | Default Value | Description |
|------------|:----:|---------------|-------------|
| name | `string` | - | **REQUIRED** The command name |
| summary | `string` | - | A short summary of the command |
| aliases | [`string`] | - | The command aliases |
| options | [[Option Object](#option-object)] | - | The command's options |
| arguments | [[Argument Object](#argument-object)] | - | The command's arguments |
Expand Down
8 changes: 4 additions & 4 deletions examples/dotnet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"$schema": "../schema.json",
"opencli": "0.1",
"opencli": "0.2",
"name": "dotnet",
"description": "The .NET CLI",
"info": {
"title": "dotnet",
"version": "9.0.1",
"description": "The .NET CLI",
"license": {
"name": "MIT License",
"identifier": "MIT",
Expand Down Expand Up @@ -36,7 +36,7 @@
"arguments": [
{
"name": "PROJECT | SOLUTION",
"description": "The project or solution file to operate on. If a file is not specified, the command will search the current directory for one.",
"description": "The project or solution file to operate on. If a file is not specified, the command will search the current directory for one."
}
],
"options": [
Expand Down
Loading