npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@kinotic/structures-cli

v2.1.1

Published

Structures CLI provides the ability to interact with the Structures Server

Downloads

26

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

nicopadillanicopadillanavidmitchellnavidmitchell

Keywords

oclif

Readme

Structures CLI

Usage

$ npm install -g @kinotic/structures-cli
$ structures COMMAND
running command...
$ structures (--version)
@kinotic/structures-cli/2.1.1 darwin-x64 node-v18.17.0
$ structures --help [COMMAND]
USAGE
  $ structures COMMAND
...

Commands

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 gen [NAMESPACE]

This will generate all Entity Service classes.

USAGE
  $ structures gen [NAMESPACE] [-v]

ARGUMENTS
  NAMESPACE  The namespace that you want to generate service classes for

FLAGS
  -v, --verbose  Enable verbose logging

DESCRIPTION
  This will generate all Entity Service classes.

ALIASES
  $ structures gen

EXAMPLES
  $ structures generate

  $ structures gen

  $ structures gen my.namespace -v

structures generate [NAMESPACE]

This will generate all Entity Service classes.

USAGE
  $ structures generate [NAMESPACE] [-v]

ARGUMENTS
  NAMESPACE  The namespace that you want to generate service classes for

FLAGS
  -v, --verbose  Enable verbose logging

DESCRIPTION
  This will generate all Entity Service classes.

ALIASES
  $ structures gen

EXAMPLES
  $ structures generate

  $ structures gen

  $ structures gen my.namespace -v

See code: src/commands/generate.ts

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.

ALIASES
  $ structures init

EXAMPLES
  $ structures initialize --namespace my.namespace --entities path/to/entities --generated path/to/services

  $ 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

structures initialize

This will initialize a new Structures Project for use with the Structures CLI.

USAGE
  $ structures initialize -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.

ALIASES
  $ structures init

EXAMPLES
  $ structures initialize --namespace my.namespace --entities path/to/entities --generated path/to/services

  $ 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/initialize.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 sync [NAMESPACE]

Synchronize the local Entity definitions with the Structures Server

USAGE
  $ structures sync [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

ALIASES
  $ structures sync

EXAMPLES
  $ structures synchronize

  $ structures sync

  $ structures synchronize my.namespace --server http://localhost:9090 --publish --verbose

  $ structures sync my.namespace -p -v -s http://localhost:9090

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

ALIASES
  $ structures sync

EXAMPLES
  $ structures synchronize

  $ structures sync

  $ structures synchronize my.namespace --server http://localhost:9090 --publish --verbose

  $ structures sync my.namespace -p -v -s http://localhost:9090

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