Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/joshcanhelp/oclif-getting-started

Sample repo for a simple oclif project.
https://github.com/joshcanhelp/oclif-getting-started

Last synced: about 2 months ago
JSON representation

Sample repo for a simple oclif project.

Awesome Lists containing this project

README

        

# Getting started with oclif

[👉 Detailed instructions on how this was built](https://www.joshcanhelp.com/oclif)

## Usage

```sh-session
$ npm install -g new-oclif-cli
$ new-oclif-cli COMMAND
running command...
$ new-oclif-cli (--version)
new-oclif-cli/1.0.0 darwin-arm64 node-v20.11.1
$ new-oclif-cli --help [COMMAND]
USAGE
$ new-oclif-cli COMMAND
...
```

## Commands

* [`new-oclif-cli hello [ARG1]`](#new-oclif-cli-hello-arg1)
* [`new-oclif-cli hello2 [FILE]`](#new-oclif-cli-hello2-file)

## `new-oclif-cli hello [ARG1]`

```
USAGE
$ new-oclif-cli hello [ARG1] [--flag]

ARGUMENTS
ARG1 First argument

FLAGS
--flag First flag
```

## `new-oclif-cli hello2 [FILE]`

describe the command here

```
USAGE
$ new-oclif-cli hello2 [FILE] [-f] [-n ]

ARGUMENTS
FILE file to read

FLAGS
-f, --force
-n, --name= name to print

DESCRIPTION
describe the command here

EXAMPLES
$ new-oclif-cli hello2
```