JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 48
  • Score
    100M100P100Q63701F
  • License Apache-2.0

Official CLI for working with Sheetbase.

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.

Build Status Coverage Status NPM License Support me on Patreon PayPal Ask me anything

Install

npm install -g @sheetbase/cli

Additional steps

Install @google/clasp

Recommended for developing Google Apps Script.

npm install -g @google/clasp

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

Develop & deploy

Backend

Develop the backend in the backend/ folder.

To authorize the script:

  • Run sheetbase url -o script, to open the script in Google Apps Script editor.
  • Publish > Deploy as web app... > Update
  • Follow the steps to authorize (ignore the warning)
  • Verify by sheetbase url -o backend

Frontend

Develop and build according to your framework of choice.

Deploy to a static hosting or build an hybrid app.

Usage

Google

Manage Google accounts. Sub-commands: list, connect, disconnect, default.

Options

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

Project

Project general tasks. Sub-commands: start, setup, config, urls, info, hooks.

Options

  • subCommand: Supported sub-commands.
  • params: Command params, comma-separated.
  • --npm: (start) Install npm packages.
  • --setup: (start) Run setup command.
  • --open: (url) Open the url in browser.
  • --database: (model) Custom database.

Start

Start a new project. Proxy of project start

Options

  • projectName: Name of the project, auto default.
  • resource: Theme or template to create the project with, default to theme blank_angular.
  • --npm: Install npm packages.
  • --setup: Run setup command.

Setup

Setup the project. Proxy of project setup

Configs

View project configs. Proxy of project configs

Config

Config backend & frontend. 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

  • --open: Open the url in browser.

Models

View project models. Proxy of project models

Model

Create model. Proxy of project model

Options

  • --database: Custom database.

Info

Output project info. Proxy of project info

Docs

Open the documentation.

Backend

Run backend related command.

Frontend

Run frontend related command.

Help

Display help.

Options

  • --detail: Detail help.

*

Any other command ends of running: npm run .

Development

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

Lisence

Sheetbase CLI is released under the Apache-2.0 license.