@kinotic/structures-cli v2.0.0
Structures CLI
Usage
$ npm install -g @kinotic/structures-cli
$ structures COMMAND
running command...
$ structures (--version)
@kinotic/structures-cli/2.0.0 darwin-x64 node-v20.11.0
$ structures --help [COMMAND]
USAGE
$ structures COMMAND
...
Commands
structures autocomplete [SHELL]
structures help [COMMAND]
structures init
structures plugins
structures plugins add PLUGIN
structures plugins:inspect PLUGIN...
structures plugins install PLUGIN
structures plugins link PATH
structures plugins remove [PLUGIN]
structures plugins reset
structures plugins uninstall [PLUGIN]
structures plugins unlink [PLUGIN]
structures plugins update
structures synchronize [NAMESPACE]
structures update [CHANNEL]
structures autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ structures autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
display autocomplete installation instructions
EXAMPLES
$ structures autocomplete
$ structures autocomplete bash
$ structures autocomplete zsh
$ structures autocomplete powershell
$ structures autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
structures help [COMMAND]
display help for structures
USAGE
$ structures help [COMMAND] [--json] [--all]
ARGUMENTS
COMMAND command to show help for
FLAGS
--all see all commands in CLI
--json Format output as json.
DESCRIPTION
display help for structures
See code: @oclif/plugin-help
structures init
This will initialize a new Structures Project for use with the Structures CLI.
USAGE
$ structures init -n <value> -e <value> -g <value>
FLAGS
-e, --entities=<value> (required) Path to the directory containing the Entity definitions
-g, --generated=<value> (required) Path to the directory to write generated Services
-n, --namespace=<value> (required) The name of the namespace you want to use
DESCRIPTION
This will initialize a new Structures Project for use with the Structures CLI.
EXAMPLES
$ structures init --namespace my.namespace --entities path/to/entities --generated path/to/services
$ structures init -n my.namespace -e path/to/entities -g path/to/services
See code: src/commands/init.ts
structures plugins
List installed plugins.
USAGE
$ structures plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ structures plugins
See code: @oclif/plugin-plugins
structures plugins add PLUGIN
Installs a plugin into structures.
USAGE
$ structures 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 structures.
Uses bundled npm executable to install plugins into /Users/navid/.local/share/structures
Installation of a user-installed plugin will override a core plugin.
Use the STRUCTURES_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the STRUCTURES_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ structures plugins add
EXAMPLES
Install a plugin from npm registry.
$ structures plugins add myplugin
Install a plugin from a github url.
$ structures plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ structures plugins add someuser/someplugin
structures plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ structures 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
$ structures plugins inspect myplugin
See code: @oclif/plugin-plugins
structures plugins install PLUGIN
Installs a plugin into structures.
USAGE
$ structures 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 structures.
Uses bundled npm executable to install plugins into /Users/navid/.local/share/structures
Installation of a user-installed plugin will override a core plugin.
Use the STRUCTURES_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the STRUCTURES_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ structures plugins add
EXAMPLES
Install a plugin from npm registry.
$ structures plugins install myplugin
Install a plugin from a github url.
$ structures plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ structures plugins install someuser/someplugin
See code: @oclif/plugin-plugins
structures plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ structures 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
$ structures plugins link myplugin
See code: @oclif/plugin-plugins
structures plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ structures 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
$ structures plugins unlink
$ structures plugins remove
EXAMPLES
$ structures plugins remove myplugin
structures plugins reset
Remove all user-installed and linked plugins.
USAGE
$ structures 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
structures plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ structures 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
$ structures plugins unlink
$ structures plugins remove
EXAMPLES
$ structures plugins uninstall myplugin
See code: @oclif/plugin-plugins
structures plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ structures 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
$ structures plugins unlink
$ structures plugins remove
EXAMPLES
$ structures plugins unlink myplugin
structures plugins update
Update installed plugins.
USAGE
$ structures plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
structures synchronize [NAMESPACE]
Synchronize the local Entity definitions with the Structures Server
USAGE
$ structures synchronize [NAMESPACE] [-s <value>] [-p] [-v] [--dryRun]
ARGUMENTS
NAMESPACE The namespace the Entities belong to
FLAGS
-p, --publish Publish each Entity after save/update
-s, --server=<value> The structures server to connect to
-v, --verbose Enable verbose logging
--dryRun Dry run enables verbose logging and does not save any changes to the server
DESCRIPTION
Synchronize the local Entity definitions with the Structures Server
EXAMPLES
$ structures synchronize my.namespace --server http://localhost:9090 --publish --verbose
$ structures synchronize my.namespace -p
$ structures synchronize
See code: src/commands/synchronize.ts
structures update [CHANNEL]
update the structures CLI
USAGE
$ structures update [CHANNEL] [-a] [--force] [-i | -v <value>]
FLAGS
-a, --available See available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the structures CLI
EXAMPLES
Update to the stable channel:
$ structures update stable
Update to a specific version:
$ structures update --version 1.0.0
Interactively select version:
$ structures update --interactive
See available versions:
$ structures update --available
See code: @oclif/plugin-update
12 days ago
27 days ago
28 days ago
28 days ago
28 days ago
28 days ago
1 month ago
2 months ago
3 months ago
4 months ago
4 months ago
5 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
10 months ago
10 months ago