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

orangepiggy-cli

v2.0.0-alpha

Published

Orange Piggy CLI =====

Downloads

6

Vulnerabilities

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

Links

Git

Maintainers

gwdebesgwdebes

Keywords

Readme

Orange Piggy CLI

oclif Version Downloads/week License Node.js Package CLI Installer Build

Usage

$ npm install -g orangepiggy-cli
$ orangepiggy COMMAND
running command...
$ orangepiggy (-v|--version|version)
orangepiggy-cli/0.1.0-beta darwin-x64 node-v13.7.0
$ orangepiggy --help [COMMAND]
USAGE
  $ orangepiggy COMMAND
...

Commands

orangepiggy autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ orangepiggy autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ orangepiggy autocomplete
  $ orangepiggy autocomplete bash
  $ orangepiggy autocomplete zsh
  $ orangepiggy autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

orangepiggy bulk /path/to/folder

Bulk upload document(s) from a path to multiple dockets by creating or using existing dockets. This command accepts just one path, being strictly a folder, and upload the documents to multiples dockets. The specified path can contain files or subfolders with files. The docket name will be the file/subfolder of the specified path.

USAGE
  $ orangepiggy bulk /path/to/folder

ARGUMENTS
  PATH  The path containing the dockets file and/or subfolders with the file(s).

OPTIONS
  -c, --concurrency=concurrency
      [default: 2] Concurrency of uploads.

  -e, --environment=environment
      [default: dev] Which environment to use. (dev, prod)

  -h, --help
      Show help

  -r, --recursive
      This option will allow subfolders of the subfolders to be considered and files to be uploaded on the referenced 
      docket.

  -v, --verbose
      Verbose mode

  -y, --yes
      Skip confimartion dialogs

  --attribute=attribute
      Optional custom attribute to be added on the dockets and documents (if noInheritance is not specified) in notation 
      --attribute 'MyAttr=Value with space'.
      Multiple custom attributes can be added using this option multiple times or using the notation --attribute 
      MyAttr=Value,MyAttr2=Value2. Values with spacing, must be enquoted into single or double quotes.
      If existing docket exists, custom attributes will not be updated on the docket.
      Environment Ivar: DOCKET_CAS

  --bucket=bucket
      Bucket ID can be specified instead of interactive selection. If not found, user will be prompt to select a new one.
      Environment Ivar: BUCKET

  --includeHidden
      This option will allow hidden files to be considered to be upload to referenced docket.

  --noInheritance
      If this option is specified, documents will not inherit tags and custom attributes from dockets.

  --notes=notes
      Optional notes to be added on the dockets and documents (if noInheritance is not specified).
      Environment Ivar: DOCKET_NOTES

  --organization=organization
      Organization alias can be specified instead of interactive selection. If not found, user will be prompt to select a 
      new one.
      Environment Ivar: ORGANIZATION

  --password=password
      Instead of using interactive login flow $orangepiggy login, password can be specified directly.
      If session from interactive login $orangepiggy login is present, this option will overwrite the saved session.
      If token expires during the upload process, the CLI will have the ability to renew it.
      Environment Ivar: AUTH_PASS

  --tag=tag
      Optional tag to be added on the dockets and documents (if noInheritance is not specified) in notation --tag 'Value 
      with space'.
      Multiple tags can be added using this option multiple times or using the notation --tag Value,Value2. Values with 
      spacing, must be enquoted into single or double quotes.
      If existing docket exists, tags will not be updated on the docket.
      Environment Ivar: DOCKET_TAG

  --useFileExtension
      If this option is specified, the docket name will include the file extension if available.

  --username=username
      Instead of using interactive login flow $orangepiggy login, username can be specified directly.
      If session from interactive login $orangepiggy login is present, this option will overwrite the saved session.
      If token expires during the upload process, the CLI will have the ability to renew it.
      Environment Ivar: AUTH_USERNAME

  --vault=vault
      Vault ID can be specified instead of interactive selection. If not found, user will be prompt to select a new one.
      Environment Ivar: VAULT

DESCRIPTION
  This command has the only requirement of the path argument, other than this, everything can be done interactive.
  Single upload operation (one docket) can be done by using $orangepiggy upload.. command.
  It also has the limitation of being a file-drive operation, if you are trying to create multiples dockets without any 
  files, use $orangepiggy create.. command.

EXAMPLES
  $orangepiggy upload /path/to/myfolder - Interactive login/org selection, creates multiple dockets with the name of the 
  files/subfolder of myfolder, with the contents of the file or files on the subfolders.
  $orangepiggy upload /path/to/myfolder --tag Hello,CLI --attribute Customer=Ikon - Interactive login/org selection, 
  creates multiple dockets with the name of the files/subfolder of myfolder, with the contents of the file or files on 
  the subfolders. All dockets and files will have that tag and attribute.

See code: src/commands/bulk.ts

orangepiggy commands

list all the commands

USAGE
  $ orangepiggy commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

orangepiggy create --name=DocketName

Create a new docket

USAGE
  $ orangepiggy create --name=DocketName

OPTIONS
  -c, --concurrency=concurrency
      [default: 2] Concurrency of uploads.

  -e, --environment=environment
      [default: dev] Which environment to use. (dev, prod)

  -h, --help
      Show help

  -v, --verbose
      Verbose mode

  -y, --yes
      Skip confimartion dialogs

  --attribute=attribute
      Optional custom attribute(s) in notation '--attribute MyAttr=Value with space'.
      Multiple custom attributes can be added using this option multiple times or using the notation --attribute 
      MyAttr=Value,MyAttr2=Value2. Values with spacing, must be enquoted into single or double quotes.
      Environment Ivar: DOCKET_CAS

  --bucket=bucket
      Bucket ID can be specified instead of interactive selection. If not found, user will be prompt to select a new one.
      Environment Ivar: BUCKET

  --name=name
      (required) Docket name of the docket being created. If existing docket found, command will throw an error.
      Environment Ivar: DOCKET_NAME

  --notes=notes
      Optional notes on the docket.
      Environment Ivar: DOCKET_NOTES

  --organization=organization
      Organization alias can be specified instead of interactive selection. If not found, user will be prompt to select a 
      new one.
      Environment Ivar: ORGANIZATION

  --password=password
      Instead of using interactive login flow $orangepiggy login, password can be specified directly.
      If session from interactive login $orangepiggy login is present, this option will overwrite the saved session.
      If token expires during the upload process, the CLI will have the ability to renew it.
      Environment Ivar: AUTH_PASS

  --tag=tag
      Optional tag(s) in notation '--tag Value with space'.
      Multiple tags can be added using this option multiple times or using the notation --tag Value,Value2. Values with 
      spacing, must be enquoted into single or double quotes.
      Environment Ivar: DOCKET_TAG

  --username=username
      Instead of using interactive login flow $orangepiggy login, username can be specified directly.
      If session from interactive login $orangepiggy login is present, this option will overwrite the saved session.
      If token expires during the upload process, the CLI will have the ability to renew it.
      Environment Ivar: AUTH_USERNAME

  --vault=vault
      Vault ID can be specified instead of interactive selection. If not found, user will be prompt to select a new one.
      Environment Ivar: VAULT

EXAMPLES
  $orangepiggy create --name=DocketName
  $orangepiggy create --name=DocketName
  $orangepiggy create --name=DocketName

See code: src/commands/create.ts

orangepiggy help [COMMAND]

display help for orangepiggy

USAGE
  $ orangepiggy help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

orangepiggy login

Login to Orange Piggy

USAGE
  $ orangepiggy login

OPTIONS
  -c, --concurrency=concurrency  [default: 2] Concurrency of uploads.
  -e, --environment=environment  [default: dev] Which environment to use. (dev, prod)
  -h, --help                     Show help
  -v, --verbose                  Verbose mode
  -y, --yes                      Skip confimartion dialogs

  --password=password            Authentication password. If not provided it will be asked in a secure prompt.
                                 Environment Ivar: AUTH_PASS

  --username=username            Authentication username.
                                 Environment Ivar: AUTH_USERNAME

EXAMPLES
  $orangepiggy login - Interactive login (if no envs are set)
  $orangepiggy login [email protected] - Interactive password prompt (if no password env is set)
  $orangepiggy login [email protected] --password="360+Example" - Direct login call

See code: src/commands/login.ts

orangepiggy logout

Logout from Orange Piggy if any persistent session is saved.

USAGE
  $ orangepiggy logout

OPTIONS
  -c, --concurrency=concurrency  [default: 2] Concurrency of uploads.
  -e, --environment=environment  [default: dev] Which environment to use. (dev, prod)
  -h, --help                     Show help
  -v, --verbose                  Verbose mode
  -y, --yes                      Skip confimartion dialogs

EXAMPLE
  $orangepiggy logout

See code: src/commands/logout.ts

orangepiggy update [CHANNEL]

update the orangepiggy CLI

USAGE
  $ orangepiggy update [CHANNEL]

See code: @oclif/plugin-update

orangepiggy upload /path/to/docket01

Upload document(s) from a path to a docket by creating or using existing docket. This command accepts just one path, being a folder or a file, and handles it on just one docket. If option --docket is not specified with the name of the docket, the CLI will use the folder/file name automatically.

USAGE
  $ orangepiggy upload /path/to/docket01

ARGUMENTS
  PATH  The path containing the docket document(s). Direct path with the file can be used as well.

OPTIONS
  -c, --concurrency=concurrency
      [default: 2] Concurrency of uploads.

  -e, --environment=environment
      [default: dev] Which environment to use. (dev, prod)

  -h, --help
      Show help

  -r, --recursive
      This option will allow subfolders to be considered and files to be uploaded on the referenced docket.

  -v, --verbose
      Verbose mode

  -y, --yes
      Skip confimartion dialogs

  --attribute=attribute
      Optional custom attribute to be added on the docket and documents (if noInheritance is not specified) in notation 
      --attribute 'MyAttr=Value with space'.
      Multiple custom attributes can be added using this option multiple times or using the notation --attribute 
      MyAttr=Value,MyAttr2=Value2. Values with spacing, must be enquoted into single or double quotes.
      If existing docket exists, custom attributes will not be updated on the docket.
      Environment Ivar: DOCKET_CAS

  --bucket=bucket
      Bucket ID can be specified instead of interactive selection. If not found, user will be prompt to select a new one.
      Environment Ivar: BUCKET

  --docket=docket
      Docket name of the docket being created. If existing docket found, user will be prompted if --yes is not specified. 
      Otherwise existing docket will be used.
      Environment Ivar: DOCKET_NAME

  --includeHidden
      This option will allow hidden files to be considered to be upload to referenced docket.

  --noInheritance
      If this option is specified, documents will not inherit tags and custom attributes from docket.

  --notes=notes
      Optional notes to be added on the docket and documents (if noInheritance is not specified).
      Environment Ivar: DOCKET_NOTES

  --organization=organization
      Organization alias can be specified instead of interactive selection. If not found, user will be prompt to select a 
      new one.
      Environment Ivar: ORGANIZATION

  --password=password
      Instead of using interactive login flow $orangepiggy login, password can be specified directly.
      If session from interactive login $orangepiggy login is present, this option will overwrite the saved session.
      If token expires during the upload process, the CLI will have the ability to renew it.
      Environment Ivar: AUTH_PASS

  --tag=tag
      Optional tag to be added on the docket and documents (if noInheritance is not specified) in notation --tag 'Value 
      with space'.
      Multiple tags can be added using this option multiple times or using the notation --tag Value,Value2. Values with 
      spacing, must be enquoted into single or double quotes.
      If existing docket exists, tags will not be updated on the docket.
      Environment Ivar: DOCKET_TAG

  --useFileExtension
      If this option is specified, the docket name will include the file extension of the specified argument.

  --username=username
      Instead of using interactive login flow $orangepiggy login, username can be specified directly.
      If session from interactive login $orangepiggy login is present, this option will overwrite the saved session.
      If token expires during the upload process, the CLI will have the ability to renew it.
      Environment Ivar: AUTH_USERNAME

  --vault=vault
      Vault ID can be specified instead of interactive selection. If not found, user will be prompt to select a new one.
      Environment Ivar: VAULT

DESCRIPTION
  This command has the only requirement of the path argument, other than this, everything can be done interactive.
  Bulk operations (multiple dockets) can be done by using $orangepiggy bulk.. command.
  It also has the limitation of being a file-drive operation, if you are trying to create a docket without any files, 
  use $orangepiggy create.. command.

EXAMPLES
  $orangepiggy upload /path/to/docket01 - Interactive login/org selection, creates a docket named docket01 with the 
  contents of the specified folder.
  $orangepiggy upload /path/to/docket01.png - Interactive login/org selection, creates a docket named docket01 with one 
  document, named docket01.png and the contents of the specifie file.
  $orangepiggy upload /path/to/docket01 --docket MyDocket - Interactive login/org selection, creates a docket named 
  MyDocket with the contents of the specified folder.
  $orangepiggy upload /path/to/docket01 --docket MyDocket --tag Hello,CLI --attribute Customer=Ikon - Interactive 
  login/org selection, creates a docket named MyDocket with the contents of the specified folder.

See code: src/commands/upload.ts