Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NobleMajo/cmdy
A js cmd argument framework that looks like the docker cli tool.
https://github.com/NobleMajo/cmdy
cli cmd cmdline javascript javascript-library linux-bash linux-shell node nodejs npm npm-library npm-package typescript typescript-library
Last synced: about 2 months ago
JSON representation
A js cmd argument framework that looks like the docker cli tool.
- Host: GitHub
- URL: https://github.com/NobleMajo/cmdy
- Owner: NobleMajo
- License: mit
- Created: 2021-12-11T23:32:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T16:35:19.000Z (over 1 year ago)
- Last Synced: 2024-04-15T17:19:56.709Z (5 months ago)
- Topics: cli, cmd, cmdline, javascript, javascript-library, linux-bash, linux-shell, node, nodejs, npm, npm-library, npm-package, typescript, typescript-library
- Language: TypeScript
- Homepage:
- Size: 472 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cmdy
# table of contents
- [cmdy](#cmdy)
- [table of contents](#table-of-contents)
- [about](#about)
- [Features](#features)
- [General](#general)
- [cmd (sub cmd)](#cmd-sub-cmd)
- [flags](#flags)
- [Getting started](#getting-started)
- [1. Install package](#1-install-package)
- [2. Add example code](#2-add-example-code)
- [npm scripts](#npm-scripts)
- [use](#use)
- [base scripts](#base-scripts)
- [watch mode](#watch-mode)
- [contribution](#contribution)
# about
"cmdy" is a node js cmd argument framework that looks like the docker cli tool.
# Features
## General
- root and sub commands
- differend cmd callbacks
- state and value flags
## cmd (sub cmd)
- own flags
- global gflas
- premade or custom help function/generator
- cmd groups
## flags
- value flags with types
- default values
- aliases
- shorthand
# Getting started
## 1. Install package
```sh
npm i cmdy
```
## 2. Add example code
```ts
import { Flag, parseCmd, CmdDefinition } from "../src/index"
const force: Flag = {
name: "force",
description: "The force flag",
}
const port: Flag = {
name: "port",
description: "The port flag",
shorthand: "p",
types: ["number"]
}
const verbose: Flag = {
name: "verbose",
description: "The verbose flag",
shorthand: "V",
}
const version: Flag = {
name: "version",
description: "The verbose flag",
alias: ["v", "ve", "ver", "vers", "versi", "versio"],
shorthand: "v",
}
const ps: CmdDefinition = {
name: "ps",
description: "The ps command",
flags: [
port
],
allowUnknownArgs: true,
exe: async (res) => console.log("ps: ", res.cmd.name + "\nres-data:\n", res.flags, res.valueFlags)
}
const start: CmdDefinition = {
name: "start",
description: "The start command",
flags: [
port
],
exe: async (res) => console.log("start: ", res.cmd.name + "\nres-data:\n", res.flags, res.valueFlags)
}
const stop: CmdDefinition = {
name: "stop",
description: "The stop command",
flags: [
force
],
exe: async (res) => console.log("stop: ", res.cmd.name + "\nres-data:\n", res.flags, res.valueFlags)
}
const root: CmdDefinition = {
name: "testcmd",
description: "The root testcmd command",
cmds: [
start,
stop,
ps,
],
flags: [
version
],
//exe: async () => console.log("asdasdd")
}
parseCmd({
cmd: root,
globalFlags: [
verbose
]
}).exe()
```
# npm scripts
The npm scripts are made for linux but can also work on mac and windows.
## use
You can run npm scripts in the project folder like this:
```sh
npm run
```
Here is an example:
```sh
npm run test
```
## base scripts
You can find all npm scripts in the `package.json` file.
This is a list of the most important npm scripts:
- test // test the app
- build // build the app
- exec // run the app
- start // build and run the app
## watch mode
Like this example you can run all npm scripts in watch mode:
```sh
npm run start:watch
```
# contribution
- 1. fork the project
- 2. implement your idea
- 3. create a pull/merge request
```ts
// please create seperated forks for different kind of featues/ideas/structure changes/implementations
```
---
**cya ;3**
*by majo418*