Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/pieroproietti/plancton

Last synced: about 1 month ago
JSON representation
Host: GitHub
URL: https://github.com/pieroproietti/plancton
Owner: pieroproietti
Created: 2024-06-22T17:37:33.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-07-07T10:28:36.000Z (6 months ago)
Last Synced: 2024-10-13T17:49:03.302Z (3 months ago)
Language: Shell
Size: 44.9 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        plancton

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

A new CLI generated with oclif

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

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

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

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g plancton

$ plancton COMMAND

running command...

$ plancton (--version)

plancton/0.0.0 linux-x64 node-v20.5.1

$ plancton --help [COMMAND]

USAGE

  $ plancton COMMAND

...

```

# Commands

* [`plancton hello PERSON`](#plancton-hello-person)

* [`plancton hello world`](#plancton-hello-world)

* [`plancton help [COMMAND]`](#plancton-help-command)

* [`plancton plugins`](#plancton-plugins)

* [`plancton plugins add PLUGIN`](#plancton-plugins-add-plugin)

* [`plancton plugins:inspect PLUGIN...`](#plancton-pluginsinspect-plugin)

* [`plancton plugins install PLUGIN`](#plancton-plugins-install-plugin)

* [`plancton plugins link PATH`](#plancton-plugins-link-path)

* [`plancton plugins remove [PLUGIN]`](#plancton-plugins-remove-plugin)

* [`plancton plugins reset`](#plancton-plugins-reset)

* [`plancton plugins uninstall [PLUGIN]`](#plancton-plugins-uninstall-plugin)

* [`plancton plugins unlink [PLUGIN]`](#plancton-plugins-unlink-plugin)

* [`plancton plugins update`](#plancton-plugins-update)

## `plancton hello PERSON`

Say hello

```

USAGE

  $ plancton hello PERSON -f 

ARGUMENTS

  PERSON  Person to say hello to

FLAGS

  -f, --from=  (required) Who is saying hello

DESCRIPTION

  Say hello

EXAMPLES

  $ plancton hello friend --from oclif

  hello friend from oclif! (./src/commands/hello/index.ts)

```

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

## `plancton hello world`

Say hello world

```

USAGE

  $ plancton hello world

DESCRIPTION

  Say hello world

EXAMPLES

  $ plancton hello world

  hello world! (./src/commands/hello/world.ts)

```

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

## `plancton help [COMMAND]`

Display help for plancton.

```

USAGE

  $ plancton help [COMMAND...] [-n]

ARGUMENTS

  COMMAND...  Command to show help for.

FLAGS

  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION

  Display help for plancton.

```

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

## `plancton plugins`

List installed plugins.

```

USAGE

  $ plancton plugins [--json] [--core]

FLAGS

  --core  Show core plugins.

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  List installed plugins.

EXAMPLES

  $ plancton plugins

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/index.ts)_

## `plancton plugins add PLUGIN`

Installs a plugin into plancton.

```

USAGE

  $ plancton plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS

  PLUGIN...  Plugin to install.

FLAGS

  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.

  -h, --help     Show CLI help.

  -s, --silent   Silences npm output.

  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Installs a plugin into plancton.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the PLANCTON_NPM_LOG_LEVEL environment variable to set the npm loglevel.

  Use the PLANCTON_NPM_REGISTRY environment variable to set the npm registry.

ALIASES

  $ plancton plugins add

EXAMPLES

  Install a plugin from npm registry.

    $ plancton plugins add myplugin

  Install a plugin from a github url.

    $ plancton plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ plancton plugins add someuser/someplugin

```

## `plancton plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```

USAGE

  $ plancton plugins inspect PLUGIN...

ARGUMENTS

  PLUGIN...  [default: .] Plugin to inspect.

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Displays installation properties of a plugin.

EXAMPLES

  $ plancton plugins inspect myplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/inspect.ts)_

## `plancton plugins install PLUGIN`

Installs a plugin into plancton.

```

USAGE

  $ plancton plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS

  PLUGIN...  Plugin to install.

FLAGS

  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.

  -h, --help     Show CLI help.

  -s, --silent   Silences npm output.

  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Installs a plugin into plancton.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the PLANCTON_NPM_LOG_LEVEL environment variable to set the npm loglevel.

  Use the PLANCTON_NPM_REGISTRY environment variable to set the npm registry.

ALIASES

  $ plancton plugins add

EXAMPLES

  Install a plugin from npm registry.

    $ plancton plugins install myplugin

  Install a plugin from a github url.

    $ plancton plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ plancton plugins install someuser/someplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/install.ts)_

## `plancton plugins link PATH`

Links a plugin into the CLI for development.

```

USAGE

  $ plancton plugins link PATH [-h] [--install] [-v]

ARGUMENTS

  PATH  [default: .] path to plugin

FLAGS

  -h, --help          Show CLI help.

  -v, --verbose

      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION

  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'

  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES

  $ plancton plugins link myplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/link.ts)_

## `plancton plugins remove [PLUGIN]`

Removes a plugin from the CLI.

```

USAGE

  $ plancton plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS

  PLUGIN...  plugin to uninstall

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Removes a plugin from the CLI.

ALIASES

  $ plancton plugins unlink

  $ plancton plugins remove

EXAMPLES

  $ plancton plugins remove myplugin

```

## `plancton plugins reset`

Remove all user-installed and linked plugins.

```

USAGE

  $ plancton plugins reset [--hard] [--reinstall]

FLAGS

  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.

  --reinstall  Reinstall all plugins after uninstalling.

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/reset.ts)_

## `plancton plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

```

USAGE

  $ plancton plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS

  PLUGIN...  plugin to uninstall

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Removes a plugin from the CLI.

ALIASES

  $ plancton plugins unlink

  $ plancton plugins remove

EXAMPLES

  $ plancton plugins uninstall myplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/uninstall.ts)_

## `plancton plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

```

USAGE

  $ plancton plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS

  PLUGIN...  plugin to uninstall

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Removes a plugin from the CLI.

ALIASES

  $ plancton plugins unlink

  $ plancton plugins remove

EXAMPLES

  $ plancton plugins unlink myplugin

```

## `plancton plugins update`

Update installed plugins.

```

USAGE

  $ plancton plugins update [-h] [-v]

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Update installed plugins.

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/update.ts)_