@sheetbase/cli

Official CLI for working with Sheetbase.

• Command overview
• Command reference
  • backend
    • build
    • deploy
    • install
    • lint
    • push
    • run
    • test
    • uninstall
  • config
    • export
    • import
    • list
    • update
  • database
    • create
    • export
    • import
    • list
  • docs
  • frontend
    • build
    • deploy
    • install
    • lint
    • prerender
    • run
    • test
    • uninstall
  • google
    • active
    • connect
    • disconnect
    • list
  • new
  • project
    • build
    • configs
    • deploy
    • info
    • lint
    • preview
    • setup
    • test
    • url
    • urls
  • update
  • help
  • *
• Detail API reference

Command overview

Official CLI for working with Sheetbase.

• sheetbase backend|b [subCommand] [params...] --message [value]
• sheetbase config|c [subCommand] [params...]
• sheetbase database|db [subCommand] [params...] --id [value] --remote --data
• sheetbase docs|d
• sheetbase frontend|f [subCommand] [params...] --message [value] --only [value] --force [value]
• sheetbase google|gg [subCommand] [params...] --yes --creds --full-drive
• sheetbase new|start|n <name> [source] --skip-install --skip-setup
• sheetbase project|p [subCommand] [params...] --fresh --open --message [value]
• sheetbase update|u --yes --self
• sheetbase help|h --detail
• sheetbase *

Command reference

backend

Backend related tasks.

Usage:

sheetbase backend [subCommand] [params...] --message [value]
sheetbase b [subCommand] [params...] --message [value]

Sub-commands:

build

Build the backend.

Usage:

sheetbase backend build

Proxy use:

sheetbase backend-build

deploy

Deploy the backend.

Usage:

sheetbase backend deploy --message [value]

Proxy use:

sheetbase backend-deploy --message [value]

Options:

• -m, --message [value]: Deployment message.

install

Install backend dependencies.

Usage:

sheetbase backend install
sheetbase backend i

Proxy use:

sheetbase backend-install

lint

Lint the backend.

Usage:

sheetbase backend lint

Proxy use:

sheetbase backend-lint

push

Push the backend.

Usage:

sheetbase backend push

Proxy use:

sheetbase backend-push

run

Run backend scripts.

Usage:

sheetbase backend run

Proxy use:

sheetbase backend-run

test

Test the backend.

Usage:

sheetbase backend test

Proxy use:

sheetbase backend-test

uninstall

Uninstall backend dependencies.

Usage:

sheetbase backend uninstall
sheetbase backend un

Proxy use:

sheetbase backend-uninstall

config

Config the project.

Usage:

sheetbase config [subCommand] [params...]
sheetbase c [subCommand] [params...]

Sub-commands:

export

Export configurations.

Usage:

sheetbase config export
sheetbase config ex

Proxy use:

sheetbase config-export

import

Import configurations.

Usage:

sheetbase config import <path>
sheetbase config im <path>

Proxy use:

sheetbase config-import <path>

Parameters:

• <path>: Path to .json file.

list

List configurations.

Usage:

sheetbase config list
sheetbase config ls

Proxy use:

sheetbase config-list

update

Update configurations.

Usage:

sheetbase config update [input...]
sheetbase config set [input...]

Proxy use:

sheetbase config-update [input...]

Parameters:

• [input...]: List of input.

database

Manage the database.

Usage:

sheetbase database [subCommand] [params...] --id [value] --remote --data
sheetbase db [subCommand] [params...] --id [value] --remote --data

Sub-commands:

create

Create tables in the database.

Usage:

sheetbase database create [input...] --id [value] --data
sheetbase database new [input...] --id [value] --data

Proxy use:

sheetbase database-create [input...] --id [value] --data

Parameters:

• [input...]: List of table names, ex.: categories posts ...

Options:

• -i, --id [value]: Custom database id.
• -d, --data: Create table with sample data.

export

Export data from the database.

Usage:

sheetbase database export <table> [dir] --id [value]
sheetbase database download <table> [dir] --id [value]
sheetbase database ex <table> [dir] --id [value]

Proxy use:

sheetbase database-export <table> [dir] --id [value]

Parameters:

• <table>: The table name.
• [dir]: Custom export folder.

Options:

• -i, --id [value]: Custom database id.

import

Import data to the database.

Usage:

sheetbase database import <table> [source] --id [value]
sheetbase database upload <table> [source] --id [value]
sheetbase database im <table> [source] --id [value]

Proxy use:

sheetbase database-import <table> [source] --id [value]

Parameters:

• <table>: The table name.
• [source]: Source to the data or default.

Options:

• -i, --id [value]: Custom database id.

list

List local or remote models.

Usage:

sheetbase database list --id [value] --remote
sheetbase database show --id [value] --remote
sheetbase database ls --id [value] --remote

Proxy use:

sheetbase database-list --id [value] --remote

Options:

• -i, --id [value]: Custom database id.
• -r, --remote: List remote tables.

docs

Open documentation.

Usage:

sheetbase docs
sheetbase d

frontend

Frontend related tasks.

Usage:

sheetbase frontend [subCommand] [params...] --message [value] --only [value] --force [value]
sheetbase f [subCommand] [params...] --message [value] --only [value] --force [value]

Sub-commands:

build

Build the frontend.

Usage:

sheetbase frontend build

Proxy use:

sheetbase frontend-build

deploy

Deploy the frontend.

Usage:

sheetbase frontend deploy --message [value]

Proxy use:

sheetbase frontend-deploy --message [value]

Options:

• -m, --message [value]: Deployment message.

install

Install frontend dependencies.

Usage:

sheetbase frontend install
sheetbase frontend i

Proxy use:

sheetbase frontend-install

lint

Lint the frontend.

Usage:

sheetbase frontend lint

Proxy use:

sheetbase frontend-lint

prerender

Prerender the frontend.

Usage:

sheetbase frontend prerender --only [value] --force [value]

Proxy use:

sheetbase frontend-prerender --only [value] --force [value]

Options:

• -o, --only [value]: Prerender only certain parts.
• -f, --force [value]: Force prerender all or certain parts.

run

Run frontend scripts.

Usage:

sheetbase frontend run

Proxy use:

sheetbase frontend-run

test

Test the frontend.

Usage:

sheetbase frontend test

Proxy use:

sheetbase frontend-test

uninstall

Uninstall frontend dependencies.

Usage:

sheetbase frontend uninstall
sheetbase frontend un

Proxy use:

sheetbase frontend-uninstall

google

Manage Google accounts.

Usage:

sheetbase google [subCommand] [params...] --yes --creds --full-drive
sheetbase gg [subCommand] [params...] --yes --creds --full-drive

Sub-commands:

active

Change the active account.

Usage:

sheetbase google active <id>
sheetbase google change <id>
sheetbase google at <id>

Proxy use:

sheetbase google-active <id>

Parameters:

• <id>: The Google account id.

connect

Connect an account.

Usage:

sheetbase google connect --yes --creds --full-drive
sheetbase google login --yes --creds --full-drive
sheetbase google cn --yes --creds --full-drive

Proxy use:

sheetbase google-connect --yes --creds --full-drive

Options:

• -y, --yes: Agree on account connection.
• -c, --creds: Save credential to .googlerc.json.
• -f, --full-drive: Not recommended, full access to Drive.

disconnect

Disconnect connected accounts.

Usage:

sheetbase google disconnect <input>
sheetbase google logout <input>
sheetbase google dc <input>

Proxy use:

sheetbase google-disconnect <input>

Parameters:

• <input>: Disconnection input: {id}, all, active, local.

list

List connected accounts.

Usage:

sheetbase google list
sheetbase google show
sheetbase google ls

Proxy use:

sheetbase google-list

new

Star a new project.

Usage:

sheetbase new <name> [source] --skip-install --skip-setup
sheetbase start <name> [source] --skip-install --skip-setup
sheetbase n <name> [source] --skip-install --skip-setup

Parameters:

• <name>: The project name.
• [source]: The custom source.

Options:

• -i, --skip-install: Skip installing npm packages.
• -s, --skip-setup: Skip project setup.

project

Project related tasks.

Usage:

sheetbase project [subCommand] [params...] --fresh --open --message [value]
sheetbase p [subCommand] [params...] --fresh --open --message [value]

Sub-commands:

build

Build the project.

Usage:

sheetbase project build

Proxy use:

sheetbase project-build
sheetbase build

configs

View project configs.

Usage:

sheetbase project configs

Proxy use:

sheetbase project-configs
sheetbase configs

deploy

Deploy the project.

Usage:

sheetbase project deploy --message [value]

Proxy use:

sheetbase project-deploy --message [value]
sheetbase deploy --message [value]

Options:

• -m, --message [value]: Deployment message.

info

Output project info.

Usage:

sheetbase project info

Proxy use:

sheetbase project-info
sheetbase info

lint

Lint the project.

Usage:

sheetbase project lint

Proxy use:

sheetbase project-lint
sheetbase lint

preview

Preview the project.

Usage:

sheetbase project preview

Proxy use:

sheetbase project-preview
sheetbase preview

setup

Setup the project.

Usage:

sheetbase project setup --fresh

Proxy use:

sheetbase project-setup --fresh
sheetbase setup --fresh

Options:

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

test

Test the project.

Usage:

sheetbase project test

Proxy use:

sheetbase project-test
sheetbase test

url

View or open a project URL.

Usage:

sheetbase project url <name> --open

Proxy use:

sheetbase project-url <name> --open
sheetbase url <name> --open

Parameters:

• <name>: The url name.

Options:

• -o, --open: Open the url in browser.

urls

View project URLs.

Usage:

sheetbase project urls

Proxy use:

sheetbase project-urls
sheetbase urls

update

Update the CLI to the latest version.

Usage:

sheetbase update --yes --self
sheetbase u --yes --self

Options:

• -y, --yes: Do update now.
• -s, --self: Update the CLI itself.

help

Display help.

Usage:

sheetbase help --detail
sheetbase h --detail

Options:

• -d, --detail: Show detail help.

*

Any other command will run: npm run <cmd>.

Usage:

sheetbase <cmd>

License

@sheetbase/cli is released under the MIT license.