https://github.com/zeionara/coda
Web app for presenting cli features
https://github.com/zeionara/coda
Last synced: 3 months ago
JSON representation
Web app for presenting cli features
- Host: GitHub
- URL: https://github.com/zeionara/coda
- Owner: zeionara
- License: apache-2.0
- Created: 2023-03-01T20:51:44.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-09T22:15:28.000Z (about 2 years ago)
- Last Synced: 2025-01-02T07:46:14.204Z (5 months ago)
- Language: TypeScript
- Size: 5.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coda
**Co**mmand **d**ocumentation **a**pp - a web tool for describing cli features.
For instruction on running the library app see docs in the [coda](/coda) folder.
## Installation
To install the project run the following command:
```sh
npm install @zeionara/coda
```
To update execute the following command:
```sh
npm install @zeionara/coda@latest
```
## Usage
Usage examples are provided in the [corresponding folder](/examples). In particular, the tool can be used as shown in the snippet below, which allows to obtain the configuration demonstrated on the image above:
```tsx
import { Command, Argument, Option, Flag, Operator, OperatorValue, Header, Fragment } from '@zeionara/coda'
function App() {
return
}
```