Kubun NPM | npm.io

kubun

Kubun CLI

Usage
Commands

Usage

$ npm install -g kubun
$ kubun COMMAND
running command...
$ kubun (--version)
kubun/0.2.0 darwin-arm64 node-v23.7.0
$ kubun --help [COMMAND]
USAGE
  $ kubun COMMAND
...

Commands

kubun account generate
kubun account id
kubun graph deploy
kubun graph mutate ID TEXT
kubun graph query ID TEXT
kubun graphql schema
kubun hello PERSON
kubun hello world
kubun help [COMMAND]
kubun model cluster
kubun model create NAME SCHEMA
kubun plugins
kubun plugins add PLUGIN
kubun plugins:inspect PLUGIN...
kubun plugins install PLUGIN
kubun plugins link PATH
kubun plugins remove [PLUGIN]
kubun plugins reset
kubun plugins uninstall [PLUGIN]
kubun plugins unlink [PLUGIN]
kubun plugins update
kubun serve

`kubun account generate`

Generate a random private key to use as account signer

USAGE
  $ kubun account generate

DESCRIPTION
  Generate a random private key to use as account signer

`kubun account id`

Display the DID of an account given its private key

USAGE
  $ kubun account id -k <value>

FLAGS
  -k, --privateKey=<value>  (required) base64-encoded private key

DESCRIPTION
  Display the DID of an account given its private key

`kubun graph deploy`

Deploy a documents model graph

USAGE
  $ kubun graph deploy -c <value>... -k <value> [--id <value>] [-n <value>] [--url <value>]

FLAGS
  -c, --cluster=<value>...  (required) path of the JSON file of the cluster
  -k, --privateKey=<value>  (required) base64-encoded private key
  -n, --name=<value>        graph name
      --id=<value>          graph ID
      --url=<value>         Kubun server URL

DESCRIPTION
  Deploy a documents model graph

`kubun graph mutate ID TEXT`

Execute a GraphQL mutation on a graph

USAGE
  $ kubun graph mutate ID TEXT -k <value> [--url <value>] [--variables <value>]

ARGUMENTS
  ID    graph ID
  TEXT  mutation text

FLAGS
  -k, --privateKey=<value>  (required) base64-encoded private key
      --url=<value>         Kubun server URL
      --variables=<value>   query variables as JSON string

DESCRIPTION
  Execute a GraphQL mutation on a graph

`kubun graph query ID TEXT`

Execute a GraphQL query on a graph

USAGE
  $ kubun graph query ID TEXT -k <value> [--url <value>] [--variables <value>]

ARGUMENTS
  ID    graph ID
  TEXT  query text

FLAGS
  -k, --privateKey=<value>  (required) base64-encoded private key
      --url=<value>         Kubun server URL
      --variables=<value>   query variables as JSON string

DESCRIPTION
  Execute a GraphQL query on a graph

`kubun graphql schema`

Create a GraphQL schema from clusters of document models

USAGE
  $ kubun graphql schema -c <value>... [-o <value>]

FLAGS
  -c, --cluster=<value>...  (required) path of the JSON file of the cluster
  -o, --output=<value>      output file for the GraphQL schema

DESCRIPTION
  Create a GraphQL schema from clusters of document models

`kubun hello PERSON`

Say hello

USAGE
  $ kubun hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ kubun hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

`kubun hello world`

Say hello world

USAGE
  $ kubun hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ kubun hello world
  hello world! (./src/commands/hello/world.ts)

`kubun help [COMMAND]`

Display help for kubun.

USAGE
  $ kubun 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 kubun.

See code: @oclif/plugin-help

`kubun model cluster`

Create a documents cluster model

USAGE
  $ kubun model cluster -m <value>... [-o <value>]

FLAGS
  -m, --model=<value>...  (required) document model as JSON string
  -o, --output=<value>    output file for the cluster

DESCRIPTION
  Create a documents cluster model

`kubun model create NAME SCHEMA`

Create a document model

USAGE
  $ kubun model create NAME SCHEMA [-b default|interface|unique] [-c] [-o <value>] [-u <value>...]

ARGUMENTS
  NAME    document model name
  SCHEMA  document schema as JSON string

FLAGS
  -b, --behavior=<option>       [default: default] behavior of the document
                                <options: default|interface|unique>
  -c, --cluster                 create a cluster model instead of a document model
  -o, --output=<value>          output file
  -u, --uniqueField=<value>...  unique field of the document when behavior is set to "unique"

DESCRIPTION
  Create a document model

`kubun plugins`

List installed plugins.

USAGE
  $ kubun plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ kubun plugins

See code: @oclif/plugin-plugins

`kubun plugins add PLUGIN`

Installs a plugin into kubun.

USAGE
  $ kubun 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 kubun.

  Uses npm to install plugins.

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

  Use the KUBUN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the KUBUN_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ kubun plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ kubun plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ kubun plugins add someuser/someplugin

`kubun plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

`kubun plugins install PLUGIN`

Installs a plugin into kubun.

USAGE
  $ kubun 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 kubun.

  Uses npm to install plugins.

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

  Use the KUBUN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the KUBUN_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ kubun plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ kubun plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ kubun plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`kubun plugins link PATH`

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

`kubun plugins remove [PLUGIN]`

Removes a plugin from the CLI.

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

EXAMPLES
  $ kubun plugins remove myplugin

`kubun plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ kubun 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

`kubun plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

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

EXAMPLES
  $ kubun plugins uninstall myplugin

See code: @oclif/plugin-plugins

`kubun plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

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

EXAMPLES
  $ kubun plugins unlink myplugin

`kubun plugins update`

Update installed plugins.

USAGE
  $ kubun plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

`kubun serve`

Start a local Kubun server

USAGE
  $ kubun serve [--db <value>] [-p <value>] [-k <value> | --id <value>]

FLAGS
  -k, --privateKey=<value>  base64-encoded private key
  -p, --port=<value>        port to listen on
      --db=<value>          path to the local SQLite database
      --id=<value>          server ID

DESCRIPTION
  Start a local Kubun server