https://github.com/stefanoruth/valon-args
A Typescript arguement parser with strong types
https://github.com/stefanoruth/valon-args
args argument-parser cli typescript
Last synced: 9 months ago
JSON representation
A Typescript arguement parser with strong types
- Host: GitHub
- URL: https://github.com/stefanoruth/valon-args
- Owner: stefanoruth
- License: mit
- Created: 2020-11-20T11:44:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-18T00:00:22.000Z (over 1 year ago)
- Last Synced: 2024-11-20T09:54:56.193Z (over 1 year ago)
- Topics: args, argument-parser, cli, typescript
- Language: TypeScript
- Homepage:
- Size: 363 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Valon Args
Typescript node argument parser with strong types.
 
## Installation
```sh
# npm
npm install valon-args
# Yarn
yarn add valon-args
# Pnpm
pnpm add valon-args
```
## Example
```ts
import { cliArgs } from 'valon-args'
const options = cliArgs({
name: { type: 'string', required: true },
retries: { type: 'number' },
force: { type: 'boolean' },
})
// All args are now typed and validated.
options.name // string
options.retires // number | undefined
options.force // boolean | undefined
```
## Documentation
```ts
import { cliArgs } from 'valon-args'
// Console args are automaticly parsed fron the terminal.
const args = cliArgs({ name: { type: 'string' } })
```
### Usage
#### String
```ts
node ./example.js --string=foo // 'foo'
node ./example.js --string="foo bar" // 'foo bar'
```
#### String[]
```ts
node ./example.js --string=foo --string=bar // ['foo', 'bar']
node ./example.js --string="foo bar" --string="bar baz" // ['foo bar', 'bar baz']
node ./example.js --string "foo bar" foobar "bar baz" // ['foo bar', 'foobar', 'bar baz']
```
#### Number
```ts
node ./example.js --number=1 // 1
```
#### Number[]
```ts
node ./example.js --number=1 --number=2 // [1, 2]
```
#### Boolean
```ts
node ./example.js --force // true
node ./example.js --force=true // true
node ./example.js --force=false // false
node ./example.js --force=1 // true
node ./example.js --force=0 // false
node ./example.js // undefined
```