@navidmitchell/monkey-cli

@navidmitchell/monkey-cli

CLI to interact with the Shop Monkey API

• Usage
• Commands

Usage

$ npm install -g @navidmitchell/monkey-cli
$ monkey COMMAND
running command...
$ monkey (--version)
@navidmitchell/monkey-cli/0.1.3 darwin-arm64 node-v22.13.1
$ monkey --help [COMMAND]
USAGE
  $ monkey COMMAND
...

Commands

• monkey config
• monkey enable-marketing
• monkey help [COMMAND]
• monkey search-customers SEARCH

monkey config

Configures the Monkey CLI with an API key

USAGE
  $ monkey config

DESCRIPTION
  Configures the Monkey CLI with an API key

EXAMPLES
  $ monkey config

See code: src/commands/config.ts

monkey enable-marketing

Enables marketing opt-in for a customer or all customers

USAGE
  $ monkey enable-marketing [-s <value>] [-d]

FLAGS
  -d, --dry-run         Run search without updating
  -s, --search=<value>  First name to search

DESCRIPTION
  Enables marketing opt-in for a customer or all customers

EXAMPLES
  $ monkey enable-marketing --search "John"

  $ monkey enable-marketing --dry-run

  $ monkey enable-marketing --search "John" --dry-run

See code: src/commands/enable-marketing.ts

monkey help [COMMAND]

Display help for monkey.

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

See code: @oclif/plugin-help

monkey search-customers SEARCH

Searches for customers by first name

USAGE
  $ monkey search-customers SEARCH

ARGUMENTS
  SEARCH  First name to search

DESCRIPTION
  Searches for customers by first name

EXAMPLES
  $ monkey search-customers "John"

See code: src/commands/search-customers.ts