quip-cli

Quip CLI

This package contains the Quip command line interface, which is used for interacting with the Quip Live Apps platform.

• Quip CLI
• Usage
• Commands

Usage

$ npm install -g quip-cli
$ qla COMMAND
running command...
$ qla (-v|--version|version)
quip-cli/1.0.0-alpha.40 linux-x64 node-v12.18.3
$ qla --help [COMMAND]
USAGE
  $ qla COMMAND
...

Commands

• qla apps
• qla bump [INCREMENT]
• qla help [COMMAND]
• qla init
• qla login
• qla migration [NAME]
• qla publish

qla apps

Browse, inspect, create, and manipulate your Apps

USAGE
  $ qla apps

OPTIONS
  -c, --create           create a new live app
  -h, --help             show CLI help
  -i, --id=id            show the details of an app ID
  -j, --json             output responses in JSON
  -s, --site=site        [default: quip.com] use a specific quip site rather than the standard quip.com login
  -v, --version=version  which version to show the details for. Only useful with --id

See code: src/commands/apps.ts

qla bump [INCREMENT]

Bump the application version

USAGE
  $ qla bump [INCREMENT]

ARGUMENTS
  INCREMENT  which number to bump - can be one of 'major', 'minor', or 'patch' - defaults to 'patch'

OPTIONS
  -h, --help  show CLI help

See code: src/commands/bump.ts

qla help [COMMAND]

display help for qla

USAGE
  $ qla help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

qla init

Initialize a new Live App Project

USAGE
  $ qla init

OPTIONS
  -h, --help  show CLI help

See code: src/commands/init.ts

qla login

Logs in to Quip and stores credentials in the .quiprc file

USAGE
  $ qla login

OPTIONS
  -f, --force      forces a re-login even if a user is currently logged in
  -h, --help       show CLI help
  -s, --site=site  [default: quip.com] use a specific quip site rather than the standard quip.com login

See code: src/commands/login.ts

qla migration [NAME]

Creates a new migration

USAGE
  $ qla migration [NAME]

ARGUMENTS
  NAME  A short description to generate the filename with

OPTIONS
  -f, --folder=folder      [default: migrations] The folder where your migrations are stored
  -h, --help               show CLI help
  -m, --manifest=manifest  A manifest.json file to add the migration to. By default, we'll use the first one we find.

  -v, --version=version    The version to generate this migration for. By default, it will use the current
                           version_number in the manifest

See code: src/commands/migration.ts

qla publish

Uploads this bundle to the developer console, and sets it as the latest development version.

USAGE
  $ qla publish

OPTIONS
  -d, --dist=dist  [default: ./dist] dist folder to upload
  -h, --help       show CLI help
  -s, --site=site  [default: quip.com] use a specific quip site rather than the standard quip.com login

See code: src/commands/publish.ts

Running locally

When developing locally, you'll iterate by calling bin/run <your-command>.

Adding new commands

This tool uses oclif to handle arg parsing and user interactivity.

To add a command to this repo, run npx oclif command <name>. For other options, check npx oclif --help