@sproutasia/sprout-cli

sprout-cli

Sprout CLI

• Usage
• Commands

Usage

$ npm install -g @sproutasia/sprout-cli
$ sprout COMMAND
running command...
$ sprout (-v|--version|version)
@sproutasia/sprout-cli/1.0.0 darwin-x64 node-v16.6.1
$ sprout --help [COMMAND]
USAGE
  $ sprout COMMAND
...

Commands

• sprout acra
• sprout airtable [ACTION]
• sprout chargebee [ACTION]
• sprout cron [ACTION]
• sprout document
• sprout help [COMMAND]
• sprout hubspot [ACTION]
• sprout token

sprout acra

ACRA command to interact with ACRA API

USAGE
  $ sprout acra

OPTIONS
  -a, --action=action    Action to call on Acra. possible actions are refresh, keyDates, entitySearch, officeHolders,
                         shareHolders

  -s, --sandbox=sandbox  Set to true if sandbox

  -u, --uen=uen          UEN of company

DESCRIPTION
  Must have a valid ACRA Token before accessing ACRA API
  refresh - Total refresh of the given UEN. Pull data from all the actions below.

  entitySearch - refreshes information such as name, incorp date
  keyDates - refreshes incorp date
  officeHolders - refreshes officeholders which includes directors and secretaries
  shareHolders - refreshes shareholders.
  connection - checks for good connection with ACRA.

See code: src/commands/acra.js

sprout airtable [ACTION]

Interact with Airtable, usually to refresh data from ACRA

USAGE
  $ sprout airtable [ACTION]

ARGUMENTS
  ACTION  (refresh|removeOrphans|connection) Action that you wanna do. See description for more info of required flags.

OPTIONS
  -m, --maxRecords=maxRecords  Max number of records to process. defaulted to 100
  -t, --table=table            The airtable base name
  -v, --view=view              Define a view where sproutCLI would look for UEN numbers.

DESCRIPTION
  Actions
  refresh - 		Must supply --view and optionally --maxRecords
  removeOrphans - 	Must supply --table name. The script would automatically look at the "Orphaned" 
  			view and remove everything without thinking.
  connetion - checks the connection stuatus

See code: src/commands/airtable.js

sprout chargebee [ACTION]

Command used to interact with Chargebee

USAGE
  $ sprout chargebee [ACTION]

ARGUMENTS
  ACTION  (refresh|linkToCompany|connection|outstandingInvoices) Action that you wanna do. See description for more info
          of required flags.

OPTIONS
  -m, --maxRecords=maxRecords  Max number of records to process. defaulted to 100
  -t, --table=table            The airtable base name
  -v, --view=view              Define a view where sproutCLI would look for UEN numbers.

See code: src/commands/chargebee.js

sprout cron [ACTION]

Contains all the regular run scripts that are required to maintain database integrity.

USAGE
  $ sprout cron [ACTION]

ARGUMENTS
  ACTION  (daily|monthly|adhoc) Action that you wanna do. See description for more info of required flags.

See code: src/commands/cron.js

sprout document

Load new ACRA Token using this command

USAGE
  $ sprout document

DESCRIPTION
  Automatically goes to ACRA to find a new Token. Required before we can interface with ACRA.

See code: src/commands/document.js

sprout help [COMMAND]

display help for sprout

USAGE
  $ sprout help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sprout hubspot [ACTION]

Command used to interact with Hubspot

USAGE
  $ sprout hubspot [ACTION]

ARGUMENTS
  ACTION  (addHubspotContactsIntoAirtable|contactsFromCompanies|deleteDuplicateCompanies|linkCompanyToHS|companiesWithou
          tContacts|syncNFYEDates|pumpUENFromView|pumpLineItemsFromView|ticketsCreateForFYEMonth|connection) Action that
          you wanna do. See description for more info of required flags.

OPTIONS
  -v, --value=value  value to action on

See code: src/commands/hubspot.js

sprout token

Load new ACRA Token using this command

USAGE
  $ sprout token

DESCRIPTION
  Automatically goes to ACRA to find a new Token. Required before we can interface with ACRA.

See code: src/commands/token.js