Sheetbase CLI

Official CLI for working with Sheetbase.

Install

npm install -g @sheetbase/cli

Additional steps

Enable Apps Script API

Go to https://script.google.com/home/usersettings, then enable the API.

Connect Apps Script in Drive

My Drive > Connect more apps > (search for Google Apps Script) > Connect

Install @google/clasp

Recommended for developing Google Apps Script, https://github.com/google/clasp.

npm install -g @google/clasp

Commands

The following commands provide many convinient methods to manage a Sheetbase project.

Note: Some of them require you to connect a Google account by sheetbase google login; project-related command needs to be run inside a Sheetbase project.

Google account

• sheetbase google list|ls [-d,--default]
• sheetbase google connect|login|add [-y,--yes] [-c,--creds] [-f,--full-drive]
• sheetbase google disconnect|logout|remove|rm <id>|all|default|local
• sheetbase google default [<id>]

Project related

• sheetbase [project] start [<projectName>] [<resource>] [-i,--install] [-x,--not-setup]
• sheetbase [project] setup [-r,--fresh]
• sheetbase [project] configs
• sheetbase [project] config update|set <key=value> ...
• sheetbase [project] config import|im <path>
• sheetbase [project] config export|ex
• sheetbase [project] urls
• sheetbase [project] url [<name>] [-o,--open]
• sheetbase [project] info
• sheetbase [project] build [-b,--backend] [-f,--frontend]
• sheetbase [project] deploy [-m,--message <value>] [-b,--backend] [-f,--frontend]
• sheetbase [project] preview

Backend specific

• sheetbase backend build
• sheetbase backend push
• sheetbase backend deploy [-m,--message <value>]
• sheetbase backend install|i
• sheetbase backend uninstall|un
• sheetbase backend run <script>
• sheetbase backend *

Frontend specific

• sheetbase frontend build
• sheetbase frontend deploy [-m,--message <value>]
• sheetbase frontend prerender [-f,--force <value>] [-o,--only <value>]
• sheetbase frontend install|i
• sheetbase frontend uninstall|un
• sheetbase frontend run <script>
• sheetbase frontend *

Database related

• sheetbase db list|ls
• sheetbase db create [input] [-i,--id <value>] [-d,--data]
• sheetbase db import|im <name> [source] [-i,--id <value>]
• sheetbase db export|ex <name> [-i,--id <value>]

Misc actions

• sheetbase docs
• sheetbase update [-y,--yes]
• sheetbase help [-d,--detail]
• sheetbase *

Reference

Google

Manage Google accounts. Sub-commands: list|ls, connect|login|add, disconnect|logout|remove|rm, default.

• subCommand: Supported sub-commands.
• params: Command params, comma-separated.
• -y,--yes: (connect) Agree on account connection.
• -c,--creds: (connect) Save credential to .googlerc.json.
• -f,--full-drive: (connect) Not recommended, grant full access to Drive.
• -d,--default: (list) Show default account only.

Project

Project general tasks. Sub-commands: start, setup, configs, config, urls, url, info, build, deploy, preview.

• subCommand: Supported sub-commands.
• params: Command params, comma-separated.
• -i,--install: (start) Install npm packages.
• -x,--not-setup: (start) Do not run setup command.
• -r,--fresh: (setup) Force re-setup.
• -o,--open: (url) Open the url in browser.
• -b,--backend: (build, deploy) Build or deploy backend only.
• -f,--frontend: (build, deploy) Build or deploy frontend only.
• -m,--message: (deploy) Deployment message.

Start

Start a new project. Proxy of project start

• projectName: Name of the project, auto default.
• resource: Resource to create the project with, default to theme blank_angular.
• -i,--install: Install npm packages.
• -x,--not-setup: Do not run setup command.

Setup

Setup the project. Proxy of project setup

• -r,--fresh: Force re-setup.

Configs

View project configs. Proxy of project configs

Config

Config the project. Proxy of project config Sub-commands: list, update, import, export

• subCommand: Optional supported sub-commands, default: list.
• params: Command params, comma-separated.

Urls

View project URLs. Proxy of project urls

Url

View or open a project URL. Proxy of project url

• name: Url name to view or open with.
• -o,--open: Open the url in browser.

Info

Output project info. Proxy of project info

Build

Build the project. Proxy of project build

• -b,--backend: Build backend only.
• -f,--frontend: Build frontend only.

Deploy

Deploy the project. Proxy of project deploy

• -b,--backend: Deploy backend only.
• -f,--frontend: Deploy frontend only.
• -m,--message: Deployment message.

Preview

Preview the project. Proxy of project preview

Backend

Run backend related commands. Sub-commands: build, push, deploy, install|i, uninstall|un, run, *.

• subCommand: Optional supported sub-commands.
• -m,--message: (deploy) Deployment message.

Frontend

Run frontend related commands. Sub-commands: build, deploy, prerender, install|i, uninstall|un, run, *.

• subCommand: Optional supported sub-commands.
• -m,--message: (deploy) Deployment message.
• -f,--force: (prerender) Force prerender all or certain parts.
• -o,--only: (prerender) Prerender only certain parts.

Db

Manage the database. Sub-commands: list|ls, create, import|im, export|ex

• subCommand: Supported sub-commands.
• params: Command params, comma-separated.
• -i,--id: The database id.
• -d,--data: (create) Create table with sample data.

Docs

Open the documentation.

Update

Check and install update.

• -y,--yes: Install update when available.

Help

Display help.

• -d,--detail: Detail help.

*

Any other command will run: npm run .

Development

API Reference: https://sheetbase.github.io/cli/api/

Lisence

Sheetbase CLI is released under the Apache-2.0 license.