Package Exports
- @sheetbase/cli
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sheetbase/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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
Usage
Manage Google accounts. Sub-commands: list|ls, connect|add, disconnect|remove|rm, default.
Options
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: (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, models, model.
Options
subCommand: Supported sub-commands.params: Command params, comma-separated.-i,--install: (start) Install npm packages.-m,--no-setup: (start) Do not run setup command.-o,--open: (url) Open the url in browser.-d,--database: (model) Custom database.-c,--clean: (model) Remove the default 'Sheet1'.-b,--backend: (build, deploy) Build or deploy backend only.-f,--frontend: (build, deploy) Build or deploy frontend only.
Start
Start a new project. Proxy of project start
Options
projectName: Name of the project, auto default.resource: Resource to create the project with, default to theme blank_angular.-i,--install: Install npm packages.-m,--no-setup: Do not run setup command.
Setup
Setup the project. Proxy of project setup
Configs
View project configs. Proxy of project configs
Config
Config the project. Proxy of project config Sub-commands: list, update, import, export
Options
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
Options
name: Url name to view or open with.-o,--open: Open the url in browser.
Models
View project models. Proxy of project models
Model
Create database models. Proxy of project model
Options
schemaFiles: List of schema files.-d,--database: Custom database.-c,--clean: Remove the default 'Sheet1'.
Info
Output project info. Proxy of project info
Build
Build the project. Proxy of project build
Options
-b,--backend: Build backend only.-f,--frontend: Build frontend only.
Deploy
Deploy the project. Proxy of project deploy
Options
-b,--backend: Deploy backend only.-f,--frontend: Deploy frontend only.
Preview
Preview the project. Proxy of project preview
Backend
Run backend related commands.
Options
subCommand: Optional supported sub-commands.
Frontend
Run frontend related commands.
Options
subCommand: Optional supported sub-commands.
Docs
Open the documentation.
Update
Check and install update.
Options
-y,--yes: Install update when available.
Help
Display help.
Options
-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.