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

bird-miniprogram-cli-dev

v1.0.5

Published

Manage mini programs

Downloads

7

Vulnerabilities

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

Links

Git

Maintainers

andyfenandyfen

Keywords

oclif

Readme

bird-miniprogram-cli

Install from local

npm run build

npm install -g .

Published

npm install -g bird-miniprogram-cli

Manage mini programs

oclif Version Downloads/week

Usage

$ npm install -g bird-miniprogram-cli-dev
$ miniprogram COMMAND
running command...
$ miniprogram (--version)
bird-miniprogram-cli-dev/1.0.5 linux-x64 node-v22.7.0
$ miniprogram --help [COMMAND]
USAGE
  $ miniprogram COMMAND
...

Commands

miniprogram account

Display account information

USAGE
  $ miniprogram account

DESCRIPTION
  Display account information

EXAMPLES
  $ miniprogram account

See code: src/commands/account/index.ts

miniprogram account delete

Deletes saved api key

USAGE
  $ miniprogram account delete

DESCRIPTION
  Deletes saved api key

EXAMPLES
  $ miniprogram account delete

See code: src/commands/account/delete.ts

miniprogram account get

Get the api key

USAGE
  $ miniprogram account get

DESCRIPTION
  Get the api key

EXAMPLES
  $ miniprogram account get

See code: src/commands/account/get.ts

miniprogram account set

Set the API key for authentication

USAGE
  $ miniprogram account set -k <value>

FLAGS
  -k, --apiKey=<value>  (required) API key for authentication

DESCRIPTION
  Set the API key for authentication

See code: src/commands/account/set.ts

miniprogram events get ID

Get details of a specific webhook event

USAGE
  $ miniprogram events get ID

ARGUMENTS
  ID  Event ID

DESCRIPTION
  Get details of a specific webhook event

EXAMPLES
  $ miniprogram events get EVENT_ID
  Get details of a specific webhook event

See code: src/commands/events/get.ts

miniprogram events list

List webhook events

USAGE
  $ miniprogram events list

DESCRIPTION
  List webhook events

See code: src/commands/events/list.ts

miniprogram events stream

Stream and list webhook events in real-time

USAGE
  $ miniprogram events stream [-s completed|failed|pending] [-t
    order.approved|order.captured|order.settled|order.shipping_address_change|order.shipping_method_change]

FLAGS
  -s, --status=<option>  Filter events by status
                         <options: completed|failed|pending>
  -t, --type=<option>    Filter events by type
                         <options: order.approved|order.captured|order.settled|order.shipping_address_change|order.shipp
                         ing_method_change>

DESCRIPTION
  Stream and list webhook events in real-time

See code: src/commands/events/stream.ts

miniprogram hello PERSON

Say hello

USAGE
  $ miniprogram hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ miniprogram hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: src/commands/hello/index.ts

miniprogram hello world

Say hello world

USAGE
  $ miniprogram hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ miniprogram hello world
  hello world! (./src/commands/hello/world.ts)

See code: src/commands/hello/world.ts

miniprogram help [COMMAND]

Display help for miniprogram.

USAGE
  $ miniprogram help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for miniprogram.

See code: @oclif/plugin-help

miniprogram miniprogram get ID

Get details of a specific Mini Program

USAGE
  $ miniprogram miniprogram get ID

ARGUMENTS
  ID  Mini Program ID

DESCRIPTION
  Get details of a specific Mini Program

EXAMPLES
  $ miniprogram miniprogram get MINIPROGRAM_ID
  Get details of a specific Mini Program

See code: src/commands/miniprogram/get.ts

miniprogram miniprogram init NAME

Initialize a new miniprogram project

USAGE
  $ miniprogram miniprogram init NAME

ARGUMENTS
  NAME  Name of the miniprogram

DESCRIPTION
  Initialize a new miniprogram project

See code: src/commands/miniprogram/init.ts

miniprogram miniprogram list

List all miniprograms

USAGE
  $ miniprogram miniprogram list

DESCRIPTION
  List all miniprograms

See code: src/commands/miniprogram/list.ts

miniprogram miniprogram publish PERSON

Builds, zips, and uploads the project to the specified server.

USAGE
  $ miniprogram miniprogram publish PERSON

ARGUMENTS
  PERSON  Person to say hello to

DESCRIPTION
  Builds, zips, and uploads the project to the specified server.

EXAMPLES
  $ miniprogram miniprogram publish friend --from oclif
        hello friend from oclif! (./src/commands/hello/index.ts)

See code: src/commands/miniprogram/publish.ts

miniprogram miniprogram update

Update an existing miniprogram

USAGE
  $ miniprogram miniprogram update [-c <value>]

FLAGS
  -c, --config=<value>  [default: miniprogram-config.json] Path to miniprogram-config.json

DESCRIPTION
  Update an existing miniprogram

ALIASES
  $ miniprogram miniprogram update

EXAMPLES
  $ miniprogram miniprogram update

  $ miniprogram miniprogram update --config custom-config.json

See code: src/commands/miniprogram/update.ts

miniprogram orders capture

Capture an existing order

USAGE
  $ miniprogram orders capture --id <value>

FLAGS
  --id=<value>  (required) ID of the order to capture

DESCRIPTION
  Capture an existing order

EXAMPLES
  $ miniprogram orders capture --id ORDER_ID
  Capture an order

See code: src/commands/orders/capture.ts

miniprogram orders create

Create a new order

USAGE
  $ miniprogram orders create --total-currency USD --total-value <value> [--cancel-url <value>] [--line-items
    <value>] [--success-url <value>]

FLAGS
  --cancel-url=<value>       URL to redirect on cancellation
  --line-items=<value>       JSON string of line items
  --success-url=<value>      URL to redirect on success
  --total-currency=<option>  (required) Currency for the order
                             <options: USD>
  --total-value=<value>      (required) Total value of the order

DESCRIPTION
  Create a new order

EXAMPLES
  $ miniprogram orders create --total-value 112.00 --total-currency USD --line-items '[{"label":"iPhone","type":"item","value":"100.00"},{"label":"Sales Tax","type":"tax","status":"pending","value":"10.00"},{"label":"Shipping","type":"shipping","value":"2.00"}]' --cancel-url https://your-cancel-url.com --success-url https://your-success-url.com
  Create a new order with specified details

See code: src/commands/orders/create.ts

miniprogram orders get ID

Get details of a specific order

USAGE
  $ miniprogram orders get ID

ARGUMENTS
  ID  Order ID

DESCRIPTION
  Get details of a specific order

EXAMPLES
  $ miniprogram orders get ORDER_ID
  Get details of a specific order

See code: src/commands/orders/get.ts

miniprogram orders list

List all orders

USAGE
  $ miniprogram orders list

DESCRIPTION
  List all orders

EXAMPLES
  $ miniprogram orders list
  Lists all orders

See code: src/commands/orders/list.ts

miniprogram orders refund ID

Refund an existing order

USAGE
  $ miniprogram orders refund ID

ARGUMENTS
  ID  ID of the order to refund

DESCRIPTION
  Refund an existing order

EXAMPLES
  $ miniprogram orders refund ORDER_ID
  Refund an order

See code: src/commands/orders/refund.ts

miniprogram orders update

Update an existing order

USAGE
  $ miniprogram orders update --id <value> --operations <value>

FLAGS
  --id=<value>          (required) ID of the order to update
  --operations=<value>  (required) JSON string of update operations

DESCRIPTION
  Update an existing order

EXAMPLES
  $ miniprogram orders update --id ORDER_ID --operations '[{"op":"replace","path":"/total/value","value":"150.00"}]'
  Update an order's total value

See code: src/commands/orders/update.ts

miniprogram plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ miniprogram plugins

See code: @oclif/plugin-plugins

miniprogram plugins add PLUGIN

Installs a plugin into miniprogram.

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

  Uses npm to install plugins.

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

  Use the MINIPROGRAM_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MINIPROGRAM_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ miniprogram plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ miniprogram plugins add myplugin

  Install a plugin from a github url.

    $ miniprogram plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ miniprogram plugins add someuser/someplugin

miniprogram plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

miniprogram plugins install PLUGIN

Installs a plugin into miniprogram.

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

  Uses npm to install plugins.

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

  Use the MINIPROGRAM_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MINIPROGRAM_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ miniprogram plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ miniprogram plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ miniprogram plugins install someuser/someplugin

See code: @oclif/plugin-plugins

miniprogram plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ miniprogram 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
  $ miniprogram plugins link myplugin

See code: @oclif/plugin-plugins

miniprogram plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ miniprogram 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
  $ miniprogram plugins unlink
  $ miniprogram plugins remove

EXAMPLES
  $ miniprogram plugins remove myplugin

miniprogram plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ miniprogram 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

miniprogram plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ miniprogram 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
  $ miniprogram plugins unlink
  $ miniprogram plugins remove

EXAMPLES
  $ miniprogram plugins uninstall myplugin

See code: @oclif/plugin-plugins

miniprogram plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ miniprogram 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
  $ miniprogram plugins unlink
  $ miniprogram plugins remove

EXAMPLES
  $ miniprogram plugins unlink myplugin

miniprogram plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

miniprogram tax get

Get tax rate for a given ZIP code

USAGE
  $ miniprogram tax get -z <value>

FLAGS
  -z, --zipCode=<value>  (required) ZIP code to get tax rate for

DESCRIPTION
  Get tax rate for a given ZIP code

EXAMPLES
  $ miniprogram tax get --zipCode 90210

See code: src/commands/tax/get.ts

miniprogram webhook create

Create a new webhook

USAGE
  $ miniprogram webhook create -u <value>

FLAGS
  -u, --url=<value>  (required) Webhook URL

DESCRIPTION
  Create a new webhook

EXAMPLES
  $ miniprogram webhook create --url https://example.com/webhook
  Create a new webhook with specified URL

See code: src/commands/webhook/create.ts

miniprogram webhook delete ID

Delete a webhook

USAGE
  $ miniprogram webhook delete ID

ARGUMENTS
  ID  Webhook ID

DESCRIPTION
  Delete a webhook

EXAMPLES
  $ miniprogram webhook delete WEBHOOK_ID
  Delete a webhook with the specified ID

See code: src/commands/webhook/delete.ts

miniprogram webhook list

List all webhooks

USAGE
  $ miniprogram webhook list

DESCRIPTION
  List all webhooks

EXAMPLES
  $ miniprogram webhook list
  List all webhooks

See code: src/commands/webhook/list.ts