bird-miniprogram-cli

#### Install from local

``
npm run build

npm install -g .
`

$3

`
npm install -g bird-miniprogram-cli
`

Manage mini programs

![oclif](https://oclif.io)
![Version](https://npmjs.org/package/bird-miniprogram-cli)
![Downloads/week](https://npmjs.org/package/bird-miniprogram-cli)


* bird-miniprogram-cli
* Usage
* Commands


Usage


`sh-session
$ 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
* miniprogram account delete
* miniprogram account get
* miniprogram account set
* miniprogram events get ID
* miniprogram events list
* miniprogram events stream
* miniprogram hello PERSON
* miniprogram hello world
* [miniprogram help [COMMAND]](#miniprogram-help-command)
* miniprogram miniprogram get ID
* miniprogram miniprogram init NAME
* miniprogram miniprogram list
* miniprogram miniprogram publish PERSON
* miniprogram miniprogram update
* miniprogram orders capture
* miniprogram orders create
* miniprogram orders get ID
* miniprogram orders list
* miniprogram orders refund ID
* miniprogram orders update
* miniprogram plugins
* miniprogram plugins add PLUGIN
* miniprogram plugins:inspect PLUGIN...
* miniprogram plugins install PLUGIN
* miniprogram plugins link PATH
* [miniprogram plugins remove [PLUGIN]](#miniprogram-plugins-remove-plugin)
* miniprogram plugins reset
* [miniprogram plugins uninstall [PLUGIN]](#miniprogram-plugins-uninstall-plugin)
* [miniprogram plugins unlink [PLUGIN]](#miniprogram-plugins-unlink-plugin)
* miniprogram plugins update
* miniprogram tax get
* miniprogram webhook create
* miniprogram webhook delete ID
* miniprogram webhook list

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

FLAGS
-k, --apiKey= (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= Filter events by status

-t, --type= Filter events by type
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

ARGUMENTS
PERSON Person to say hello to

FLAGS
-f, --from= (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 ]

FLAGS
-c, --config= [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

FLAGS
--id= (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 [--cancel-url ] [--line-items
] [--success-url ]

FLAGS
--cancel-url= URL to redirect on cancellation
--line-items= JSON string of line items
--success-url= URL to redirect on success
--total-currency= (required) Currency for the order

--total-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 --operations

FLAGS
--id= (required) ID of the order to update
--operations= (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

FLAGS
-z, --zipCode= (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

FLAGS
-u, --url= (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_