Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/status-board/status-board-cli

CLI utility for status board
https://github.com/status-board/status-board-cli

Last synced: 24 days ago
JSON representation

CLI utility for status board

Host: GitHub
URL: https://github.com/status-board/status-board-cli
Owner: status-board
License: mit
Created: 2017-11-10T11:20:19.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2023-03-01T14:38:09.000Z (almost 2 years ago)
Last Synced: 2024-08-09T10:02:56.807Z (5 months ago)
Language: JavaScript
Homepage:
Size: 4.32 MB
Stars: 4
Watchers: 4
Forks: 1
Open Issues: 41
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        status-board-cli

================

CLI utility for Status Board

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

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

[![CircleCI](https://circleci.com/gh/jameswlane/status-board-cli/tree/master.svg?style=shield)](https://circleci.com/gh/jameswlane/status-board-cli/tree/master)

[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/jameswlane/status-board-cli?branch=master&svg=true)](https://ci.appveyor.com/project/jameswlane/status-board-cli/branch/master)

[![Codecov](https://codecov.io/gh/jameswlane/status-board-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/jameswlane/status-board-cli)

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

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

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npx status-board-cli COMMAND

running command...

```

To install

```sh-session

$ npm install -g status-board-cli

$ status-board COMMAND

running command...

$ status-board (-v|--version|version)

status-board-cli/0.0.0 darwin-x64 node-v8.11.1

$ status-board --help [COMMAND]

USAGE

  $ status-board COMMAND

...

```

# Commands

* [`status-board generate [FILE]`](#status-board-generate-file)

* [`status-board help [COMMAND]`](#status-board-help-command)

* [`status-board install [FILE]`](#status-board-install-file)

* [`status-board list [FILE]`](#status-board-list-file)

* [`status-board new [FILE]`](#status-board-new-file)

* [`status-board start [FILE]`](#status-board-start-file)

## `status-board generate [FILE]`

describe the command here

```

USAGE

  $ status-board generate [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

```

_See code: [src/commands/generate.ts](https://github.com/jameswlane/status-board-cli/blob/v0.0.0/src/commands/generate.ts)_

## `status-board help [COMMAND]`

display help for status-board

```

USAGE

  $ status-board help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.3/src/commands/help.ts)_

## `status-board install [FILE]`

describe the command here

```

USAGE

  $ status-board install [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

```

_See code: [src/commands/install.ts](https://github.com/jameswlane/status-board-cli/blob/v0.0.0/src/commands/install.ts)_

## `status-board list [FILE]`

describe the command here

```

USAGE

  $ status-board list [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

```

_See code: [src/commands/list.ts](https://github.com/jameswlane/status-board-cli/blob/v0.0.0/src/commands/list.ts)_

## `status-board new [FILE]`

describe the command here

```

USAGE

  $ status-board new [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

```

_See code: [src/commands/new.ts](https://github.com/jameswlane/status-board-cli/blob/v0.0.0/src/commands/new.ts)_

## `status-board start [FILE]`

describe the command here

```

USAGE

  $ status-board start [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

```

_See code: [src/commands/start.ts](https://github.com/jameswlane/status-board-cli/blob/v0.0.0/src/commands/start.ts)_