Files
jj-command-line/README.md
T
2024-11-09 01:49:57 -05:00

354 lines
7.2 KiB
Markdown

jj
=================
jj cli
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/jj.svg)](https://npmjs.org/package/jj)
[![Downloads/week](https://img.shields.io/npm/dw/jj.svg)](https://npmjs.org/package/jj)
<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g jj-command-line
$ jj COMMAND
running command...
$ jj (--version)
jj-command-line/0.0.1 darwin-arm64 node-v20.16.0
$ jj --help [COMMAND]
USAGE
$ jj COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`jj help [COMMAND]`](#jj-help-command)
* [`jj plugins`](#jj-plugins)
* [`jj plugins add PLUGIN`](#jj-plugins-add-plugin)
* [`jj plugins:inspect PLUGIN...`](#jj-pluginsinspect-plugin)
* [`jj plugins install PLUGIN`](#jj-plugins-install-plugin)
* [`jj plugins link PATH`](#jj-plugins-link-path)
* [`jj plugins remove [PLUGIN]`](#jj-plugins-remove-plugin)
* [`jj plugins reset`](#jj-plugins-reset)
* [`jj plugins uninstall [PLUGIN]`](#jj-plugins-uninstall-plugin)
* [`jj plugins unlink [PLUGIN]`](#jj-plugins-unlink-plugin)
* [`jj plugins update`](#jj-plugins-update)
## `jj help [COMMAND]`
Display help for jj.
```
USAGE
$ jj 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 jj.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
## `jj plugins`
List installed plugins.
```
USAGE
$ jj plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ jj plugins
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/index.ts)_
## `jj plugins add PLUGIN`
Installs a plugin into jj.
```
USAGE
$ jj 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 jj.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the JJ_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the JJ_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ jj plugins add
EXAMPLES
Install a plugin from npm registry.
$ jj plugins add myplugin
Install a plugin from a github url.
$ jj plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ jj plugins add someuser/someplugin
```
## `jj plugins:inspect PLUGIN...`
Displays installation properties of a plugin.
```
USAGE
$ jj 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
$ jj plugins inspect myplugin
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/inspect.ts)_
## `jj plugins install PLUGIN`
Installs a plugin into jj.
```
USAGE
$ jj 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 jj.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the JJ_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the JJ_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ jj plugins add
EXAMPLES
Install a plugin from npm registry.
$ jj plugins install myplugin
Install a plugin from a github url.
$ jj plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ jj plugins install someuser/someplugin
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/install.ts)_
## `jj plugins link PATH`
Links a plugin into the CLI for development.
```
USAGE
$ jj 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
$ jj plugins link myplugin
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/link.ts)_
## `jj plugins remove [PLUGIN]`
Removes a plugin from the CLI.
```
USAGE
$ jj 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
$ jj plugins unlink
$ jj plugins remove
EXAMPLES
$ jj plugins remove myplugin
```
## `jj plugins reset`
Remove all user-installed and linked plugins.
```
USAGE
$ jj 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.4.15/src/commands/plugins/reset.ts)_
## `jj plugins uninstall [PLUGIN]`
Removes a plugin from the CLI.
```
USAGE
$ jj 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
$ jj plugins unlink
$ jj plugins remove
EXAMPLES
$ jj plugins uninstall myplugin
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/uninstall.ts)_
## `jj plugins unlink [PLUGIN]`
Removes a plugin from the CLI.
```
USAGE
$ jj 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
$ jj plugins unlink
$ jj plugins remove
EXAMPLES
$ jj plugins unlink myplugin
```
## `jj plugins update`
Update installed plugins.
```
USAGE
$ jj 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.4.15/src/commands/plugins/update.ts)_
<!-- commandsstop -->