npm package: @quable/quable-cli
Description: A CLI tool to build for the Quable PIM platform
Author: quable
Latest version: 2.0.0

# QUABLE CLI

[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE)


# Usage

<!-- usage -->
```sh-session
$ npm install -g @quable/quable-cli
$ quable COMMAND
running command...
$ quable (--version)
@quable/quable-cli/2.0.0 darwin-x64 node-v24.10.0
$ quable --help [COMMAND]
USAGE
  $ quable COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`quable app`](#quable-app)
* [`quable app create`](#quable-app-create)
* [`quable app dev`](#quable-app-dev)
* [`quable help [COMMAND]`](#quable-help-command)
* [`quable plugins`](#quable-plugins)
* [`quable plugins add PLUGIN`](#quable-plugins-add-plugin)
* [`quable plugins:inspect PLUGIN...`](#quable-pluginsinspect-plugin)
* [`quable plugins install PLUGIN`](#quable-plugins-install-plugin)
* [`quable plugins link PATH`](#quable-plugins-link-path)
* [`quable plugins remove [PLUGIN]`](#quable-plugins-remove-plugin)
* [`quable plugins reset`](#quable-plugins-reset)
* [`quable plugins uninstall [PLUGIN]`](#quable-plugins-uninstall-plugin)
* [`quable plugins unlink [PLUGIN]`](#quable-plugins-unlink-plugin)
* [`quable plugins update`](#quable-plugins-update)

## `quable app`

Build Quable apps.

```
USAGE
  $ quable app

DESCRIPTION
  Build Quable apps.

EXAMPLES
  $ quable app dev
```

_See code: [src/commands/app/index.ts](https://github.com/Quable/quable-cli-v2/blob/v2.0.0/src/commands/app/index.ts)_

## `quable app create`

Generate new Quable App based on our App Template.

```
USAGE
  $ quable app create

DESCRIPTION
  Generate new Quable App based on our App Template.

EXAMPLES
  $ quable app create --help
```

_See code: [src/commands/app/create.ts](https://github.com/Quable/quable-cli-v2/blob/v2.0.0/src/commands/app/create.ts)_

## `quable app dev`

Initialize and configure a Quable App for local development.

```
USAGE
  $ quable app dev [--backend-port <value>] [--frontend-port <value>] [-i <value>] [--no-tunnel] [--reset]
    [--skip-database-sync] [-s] [--tunnel-url <value>]

FLAGS
  -i, --instance=<value>                Quable PIM Instance name. Must be an existing instance linked on your partner
                                        dashboard.
  -s, --skip-dependencies-installation  Skips the installation of dependencies
      --backend-port=<value>            Specifies the port for the Quable backend application.
      --frontend-port=<value>           Specifies the port for the Quable frontend application. Only applicable for
                                        full-stack applications
      --no-tunnel                       Automatic creation of a tunnel is disabled. Service entry point will listen to
                                        localhost instead
      --reset                           Reset all your settings.
      --skip-database-sync              Skip database synchronization
      --tunnel-url=<value>              Use a custom tunnel, it must be running before executing dev.

DESCRIPTION
  Initialize and configure a Quable App for local development.

EXAMPLES
  $ quable app dev --help
```

_See code: [src/commands/app/dev.ts](https://github.com/Quable/quable-cli-v2/blob/v2.0.0/src/commands/app/dev.ts)_

## `quable help [COMMAND]`

Display help for quable.

```
USAGE
  $ quable 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 quable.
```

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

## `quable plugins`

List installed plugins.

```
USAGE
  $ quable plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ quable plugins
```

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

## `quable plugins add PLUGIN`

Installs a plugin into quable.

```
USAGE
  $ quable 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 quable.

  Uses npm to install plugins.

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

  Use the QUABLE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the QUABLE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ quable plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ quable plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ quable plugins add someuser/someplugin
```

## `quable plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ quable 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
  $ quable plugins inspect myplugin
```

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

## `quable plugins install PLUGIN`

Installs a plugin into quable.

```
USAGE
  $ quable 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 quable.

  Uses npm to install plugins.

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

  Use the QUABLE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the QUABLE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ quable plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ quable plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ quable plugins install someuser/someplugin
```

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

## `quable plugins link PATH`

Links a plugin into the CLI for development.

```
USAGE
  $ quable 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
  $ quable plugins link myplugin
```

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

## `quable plugins remove [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ quable 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
  $ quable plugins unlink
  $ quable plugins remove

EXAMPLES
  $ quable plugins remove myplugin
```

## `quable plugins reset`

Remove all user-installed and linked plugins.

```
USAGE
  $ quable 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.54/src/commands/plugins/reset.ts)_

## `quable plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ quable 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
  $ quable plugins unlink
  $ quable plugins remove

EXAMPLES
  $ quable plugins uninstall myplugin
```

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

## `quable plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ quable 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
  $ quable plugins unlink
  $ quable plugins remove

EXAMPLES
  $ quable plugins unlink myplugin
```

## `quable plugins update`

Update installed plugins.

```
USAGE
  $ quable 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.54/src/commands/plugins/update.ts)_
<!-- commandsstop -->
* [`quable app create`](#quable-app-create)
* [`quable app dev`](#quable-app-dev)
* [`quable help [COMMANDS]`](#quable-help-commands)


## `quable app create`

Generate new quable app based on our starter app.

```
USAGE
  $ quable app create

DESCRIPTION
  Generate new quable app based on our starter app.

EXAMPLES
  $ quable app create --help
```


## `quable app dev`

Initialize and configure a Quable app for local development.

```
USAGE
  $ quable app dev [-i <value>] [--reset] [-s] [--skip-database-sync] [--tunnel-url <value>] [--no-tunnel]

FLAGS
  -i, --instance=<value>                Quable PIM Instance name. Must be an existing instance linked on your partner
                                        dashboard.
  -s, --skip-dependencies-installation  Skips the installation of dependencies
  --no-tunnel                           Automatic creation of a tunnel is disabled. Service entry point will listen to
                                        localhost instead
  --reset                               Reset all your settings.
  --skip-database-sync                  Skip database synchronization
  --tunnel-url=<value>                  Use a custom tunnel, it must be running before executing dev.

DESCRIPTION
  Initialize and configure a Quable app for local development.

EXAMPLES
  $ quable app dev --help
```

## `quable help [COMMANDS]`

Display help for quable.

```
USAGE
  $ quable help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for quable.
```