@sharinpix/sharinpix-cli

SharinPix CLI

This is a simple CLI for SharinPix API

• Usage
• Pre-requisite
• Commands

Usage

$ npm install -g @sharinpix/sharinpix-cli
$ spx COMMAND
running command...
$ spx (--version)
@sharinpix/sharinpix-cli/0.0.15 linux-x64 node-v18.18.0
$ spx --help [COMMAND]
USAGE
  $ spx COMMAND
...

Pre-requisite

Before you can execute any command from the SharinPix CLI, you need to find the SharinPix Secret URL.

Find your SharinPix secret url and execute the following command in your terminal (make sure to replace the secret url with yours)

export SHARINPIX_SECRET_URL=sharinpix://02cc044f-xxxx-xxxx-8b72-0eabb16a21cb:[e-mail]/api/v1

Commands

• spx help [COMMANDS]
• spx import file
• spx plugins
• spx plugins:install PLUGIN...
• spx plugins:inspect PLUGIN...
• spx plugins:install PLUGIN...
• spx plugins:link PLUGIN
• spx plugins:uninstall PLUGIN...
• spx plugins:uninstall PLUGIN...
• spx plugins:uninstall PLUGIN...
• spx plugins update

spx help [COMMANDS]

Display help for spx.

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

See code: @oclif/plugin-help

spx import file

describe the command here

USAGE
  $ spx import file -p <value> [-f]

FLAGS
  -f, --force
  -p, --path=<value>  (required) path to CSV file

DESCRIPTION
  describe the command here

EXAMPLES
  $ spx import file

See code: src/commands/import/file.ts

spx plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ spx plugins

See code: @oclif/plugin-plugins

spx plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ spx plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ spx plugins add

EXAMPLES
  $ spx plugins:install myplugin 

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

  $ spx plugins:install someuser/someplugin

spx plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

spx plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ spx plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ spx plugins add

EXAMPLES
  $ spx plugins:install myplugin 

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

  $ spx plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

spx plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ spx plugins:link PLUGIN

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
  $ spx plugins:link myplugin

See code: @oclif/plugin-plugins

spx plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ spx plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ spx plugins unlink
  $ spx plugins remove

spx plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ spx plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ spx plugins unlink
  $ spx plugins remove

See code: @oclif/plugin-plugins

spx plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ spx plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ spx plugins unlink
  $ spx plugins remove

spx plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

• spx import file

spx import file --path <path_to_csv_file>

Bulk upload images from your computer to SharinPix using a CSV file

USAGE
  $ spx import file -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -p, --path=<value>  (required) Path to the CSV file (see sample below)

DESCRIPTION
  Bulk upload local images to SharinPix

EXAMPLES
  $ spx import file --path ./test/import.csv
  Processed ID: 00324000004GUxhAAG, Path: /home/kevan/Pictures/Sample/sample.jpg, Tags: Hello, filename: sample.jpg