Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oclif/dev-cli
https://github.com/oclif/dev-cli
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/oclif/dev-cli
- Owner: oclif
- License: mit
- Archived: true
- Created: 2018-02-02T06:18:13.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2022-04-10T06:26:27.000Z (over 2 years ago)
- Last Synced: 2024-04-12T16:55:23.346Z (7 months ago)
- Language: TypeScript
- Size: 2.75 MB
- Stars: 60
- Watchers: 6
- Forks: 58
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
@oclif/dev-cli
===============
**This library has been replaced by [oclif](https://github.com/oclif) and is now in maintenance mode. We will only consider PRs that address security concerns.**
helpers for oclif CLIs
[](https://npmjs.org/package/@oclif/dev-cli)
[](https://circleci.com/gh/oclif/dev-cli/tree/master)
[](https://ci.appveyor.com/project/heroku/dev-cli/branch/master)
[](https://snyk.io/test/npm/@oclif/dev-cli)
[](https://npmjs.org/package/@oclif/dev-cli)
[](https://github.com/oclif/dev-cli/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g @oclif/dev-cli
$ oclif-dev COMMAND
running command...
$ oclif-dev (-v|--version|version)
@oclif/dev-cli/1.26.10 linux-x64 node-v14.18.2
$ oclif-dev --help [COMMAND]
USAGE
$ oclif-dev COMMAND
...
```
# Commands
* [`oclif-dev help [COMMAND]`](#oclif-dev-help-command)
* [`oclif-dev manifest [PATH]`](#oclif-dev-manifest-path)
* [`oclif-dev pack`](#oclif-dev-pack)
* [`oclif-dev pack:deb`](#oclif-dev-packdeb)
* [`oclif-dev pack:macos`](#oclif-dev-packmacos)
* [`oclif-dev pack:win`](#oclif-dev-packwin)
* [`oclif-dev publish`](#oclif-dev-publish)
* [`oclif-dev publish:deb`](#oclif-dev-publishdeb)
* [`oclif-dev publish:macos`](#oclif-dev-publishmacos)
* [`oclif-dev publish:win`](#oclif-dev-publishwin)
* [`oclif-dev readme`](#oclif-dev-readme)
## `oclif-dev help [COMMAND]`
display help for oclif-dev
```
USAGE
$ oclif-dev 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/v3.2.18/src/commands/help.ts)_
## `oclif-dev manifest [PATH]`
generates plugin manifest json
```
USAGE
$ oclif-dev manifest [PATH]
ARGUMENTS
PATH [default: .] path to plugin
```
_See code: [src/commands/manifest.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/manifest.ts)_
## `oclif-dev pack`
packages oclif cli into tarballs
```
USAGE
$ oclif-dev pack
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
-t, --targets=targets comma-separated targets to pack (e.g.: linux-arm,win32-x64)
--[no-]xz also build xz
DESCRIPTION
This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.
```
_See code: [src/commands/pack/index.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/pack/index.ts)_
## `oclif-dev pack:deb`
pack CLI into debian package
```
USAGE
$ oclif-dev pack:deb
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
```
_See code: [src/commands/pack/deb.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/pack/deb.ts)_
## `oclif-dev pack:macos`
pack CLI into MacOS .pkg
```
USAGE
$ oclif-dev pack:macos
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
```
_See code: [src/commands/pack/macos.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/pack/macos.ts)_
## `oclif-dev pack:win`
create windows installer from oclif CLI
```
USAGE
$ oclif-dev pack:win
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
```
_See code: [src/commands/pack/win.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/pack/win.ts)_
## `oclif-dev publish`
publish an oclif CLI to S3
```
USAGE
$ oclif-dev publish
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
-t, --targets=targets comma-separated targets to pack (e.g.: linux-arm,win32-x64)
DESCRIPTION
"aws-sdk" will need to be installed as a devDependency to publish.
```
_See code: [src/commands/publish/index.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/publish/index.ts)_
## `oclif-dev publish:deb`
publish deb package built with pack:deb
```
USAGE
$ oclif-dev publish:deb
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
```
_See code: [src/commands/publish/deb.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/publish/deb.ts)_
## `oclif-dev publish:macos`
publish macos installers built with pack:macos
```
USAGE
$ oclif-dev publish:macos
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
```
_See code: [src/commands/publish/macos.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/publish/macos.ts)_
## `oclif-dev publish:win`
publish windows installers built with pack:win
```
USAGE
$ oclif-dev publish:win
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
```
_See code: [src/commands/publish/win.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/publish/win.ts)_
## `oclif-dev readme`
adds commands to README.md in current directory
```
USAGE
$ oclif-dev readme
OPTIONS
--dir=dir (required) [default: docs] output directory for multi docs
--multi create a different markdown page for each topic
DESCRIPTION
The readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:
# Usage
# Commands
Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
```
_See code: [src/commands/readme.ts](https://github.com/oclif/dev-cli/blob/v1.26.10/src/commands/readme.ts)_