This is a simple CLI for SharinPix API
$ npm install -g @sharinpix/sharinpix-cli
$ sharinpix COMMAND
running command...
$ sharinpix (--version)
@sharinpix/sharinpix-cli/0.0.14 linux-x64 node-v18.16.0
$ sharinpix --help [COMMAND]
USAGE
$ sharinpix COMMAND
...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:MplDxxxxvRLPX_kHM-BDe0PkoVlncsiGkoxxxxsheOAJyUU@api.sharinpix.com/api/v1sharinpix help [COMMANDS]sharinpix import filesharinpix pluginssharinpix plugins:install PLUGIN...sharinpix plugins:inspect PLUGIN...sharinpix plugins:install PLUGIN...sharinpix plugins:link PLUGINsharinpix plugins:uninstall PLUGIN...sharinpix plugins:uninstall PLUGIN...sharinpix plugins:uninstall PLUGIN...sharinpix plugins update
Display help for sharinpix.
USAGE
$ sharinpix 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 sharinpix.
See code: @oclif/plugin-help
describe the command here
USAGE
$ sharinpix import file -p <value> [-f]
FLAGS
-f, --force
-p, --path=<value> (required) path to CSV file
DESCRIPTION
describe the command here
EXAMPLES
$ sharinpix import file
See code: src/commands/import/file.ts
List installed plugins.
USAGE
$ sharinpix plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ sharinpix plugins
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ sharinpix 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
$ sharinpix plugins add
EXAMPLES
$ sharinpix plugins:install myplugin
$ sharinpix plugins:install https://github.com/someuser/someplugin
$ sharinpix plugins:install someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ sharinpix 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
$ sharinpix plugins:inspect myplugin
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ sharinpix 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
$ sharinpix plugins add
EXAMPLES
$ sharinpix plugins:install myplugin
$ sharinpix plugins:install https://github.com/someuser/someplugin
$ sharinpix plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
Links a plugin into the CLI for development.
USAGE
$ sharinpix 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
$ sharinpix plugins:link myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ sharinpix plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ sharinpix plugins unlink
$ sharinpix plugins remove
Removes a plugin from the CLI.
USAGE
$ sharinpix plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ sharinpix plugins unlink
$ sharinpix plugins remove
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ sharinpix plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ sharinpix plugins unlink
$ sharinpix plugins remove
Update installed plugins.
USAGE
$ sharinpix plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
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