https://github.com/natzcam/conf-cli

simple cli for configuration and key/value's + oclif plugin for configuration
https://github.com/natzcam/conf-cli

Last synced: about 2 months ago
JSON representation

simple cli for configuration and key/value's + oclif plugin for configuration

• Host: GitHub
• URL: https://github.com/natzcam/conf-cli
• Owner: natzcam
• License: mit
• Created: 2018-10-10T11:37:32.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T13:59:19.000Z (about 2 years ago)
• Last Synced: 2024-10-14T01:17:32.056Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 343 KB
• Stars: 27
• Watchers: 3
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
conf-cli

========

> * simple cli interface for [sindresorhus/conf](https://github.com/sindresorhus/conf)

> * [oclif plugin](https://oclif.io/docs/plugins) that adds a `conf` command that lets you manage state/configuration between commands

> * standalone key/value store

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/conf-cli.svg)](https://npmjs.org/package/conf-cli)

[![Downloads/week](https://img.shields.io/npm/dw/conf-cli.svg)](https://npmjs.org/package/conf-cli)

[![License](https://img.shields.io/npm/l/conf-cli.svg)](https://github.com/natzcam/conf-cli/blob/master/package.json)

# Install

```

npm install -g conf-cli

```

## `conf [KEY] [VALUE]`

manage configuration

```

USAGE

  $ conf [KEY] [VALUE]

ARGUMENTS

  KEY    key of the config

  VALUE  value of the config

OPTIONS

  -d, --cwd=cwd          config file location

  -d, --delete           delete?

  -h, --help             show CLI help

  -k, --key=key          key of the config

  -n, --name=name        config file name

  -p, --project=project  project name

  -v, --value=value      value of the config

```

> * if [VALUE] is not provided, value of the key is printed

> * if [KEY] and [VALUE] is not provided, all the keys will be printed

_See code: [src\commands\conf.ts](https://github.com/natzcam/conf-cli/blob/v0.1.1/src\commands\conf.ts)_

# Usage

## as [sindresorhus/conf](https://github.com/sindresorhus/conf) cli interface

use sindresorhus/conf in your app

```javascript

// simple-example/index.js

const Conf = require('conf');

const config = new Conf();

console.log(`hello ${config.get('name')}!`);

```

use conf-cli to update `name` property from outside the app.

--project/-p flag sets the target project (package name).

```sh-session

$ conf name world -p simple-example

```

see it affect simple-example

```sh-session

$ node simple-example/index.js

hello world!

```

## as an [oclif plugin](https://oclif.io/docs/plugins)

create a new oclif project

```sh-session

$ oclif multi oclif-example

```

install conf-cli

```sh-session

$ npm install --save conf-cli

```

add to oclif plugins in package.json

```javascript

 "oclif": {

    "plugins": [

      "conf-cli"

    ]

  },

```

```sh-session

$ oclif-example

VERSION

  oclif-example/0.0.0 win32-x64 node-v8.9.1

USAGE

  $ oclif-example [COMMAND]

COMMANDS

  conf   manage configuration <=========== yahoo! ;)

  hello  Describe the command here

  help   display help for oclif-example

```

When used as a plugin, -p will default to the parent cli package name.

```sh-session

$ oclif-example conf name daenarys

$ oclif-example hello

hello daenarys!

$ conf -p oclif-example name

daenarys

```

```javascript

//src/commands/hello.js

class HelloCommand extends Command {

  async run() {

    this.log(`hello ${config.get('name')}!`);

  }

}

```

## as a standalone key/value store

```sh-session

$ conf hello jonsnow

$ conf hi varys

$ conf hello

jonsnow

$ conf hi

varys

$ conf

hello

hi

```

# Examples

[here](https://github.com/natzcam/conf-cli/tree/master/example)