https://github.com/kazuma1989/hello-oclif

https://github.com/kazuma1989/hello-oclif

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kazuma1989/hello-oclif
• Owner: kazuma1989
• Created: 2020-02-16T03:21:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-13T01:31:14.000Z (over 3 years ago)
• Last Synced: 2025-01-22T09:33:08.844Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 547 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
hello-oclif

===========

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

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

[![CircleCI](https://circleci.com/gh/kazuma1989/hello-oclif/tree/master.svg?style=shield)](https://circleci.com/gh/kazuma1989/hello-oclif/tree/master)

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

[![License](https://img.shields.io/npm/l/hello-oclif.svg)](https://github.com/kazuma1989/hello-oclif/blob/master/package.json)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g hello-oclif

$ hello-oclif COMMAND

running command...

$ hello-oclif (-v|--version|version)

hello-oclif/0.0.0 darwin-x64 node-v13.8.0

$ hello-oclif --help [COMMAND]

USAGE

  $ hello-oclif COMMAND

...

```

# Commands

* [`hello-oclif hello [FILE]`](#hello-oclif-hello-file)

* [`hello-oclif help [COMMAND]`](#hello-oclif-help-command)

## `hello-oclif hello [FILE]`

describe the command here

```

USAGE

  $ hello-oclif hello [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

EXAMPLE

  $ hello-oclif hello

  hello world from ./src/hello.ts!

```

_See code: [src/commands/hello.ts](https://github.com/kazuma1989/hello-oclif/blob/v0.0.0/src/commands/hello.ts)_

## `hello-oclif help [COMMAND]`

display help for hello-oclif

```

USAGE

  $ hello-oclif 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.2.3/src/commands/help.ts)_