Git Product home page Git Product logo

clasp's Introduction

clasp

Develop Apps Script projects locally using clasp (Command Line Apps Script Projects).

clasp

To get started, try out the codelab!

Install

First download clasp:

npm i @google/clasp -g

Then enable Apps Script API: https://script.google.com/home/usersettings

Features

πŸ—ΊοΈ Develop Locally: clasp allows you to develop your Apps Script projects locally. That means you can check-in your code into source control, collaborate with other developers, and use your favorite tools to develop Apps Script.

πŸ”’ Manage Deployment Versions: Create, update, and view your multiple deployments of your project.

πŸ“ Structure Code: clasp automatically converts your flat project on script.google.com into folders. For example:

  • On script.google.com:
    • tests/slides.gs
    • tests/sheets.gs
  • locally:
    • tests/
      • slides.js
      • sheets.js

Commands

clasp -h
  • clasp login
  • clasp logout
  • clasp create [scriptTitle]
  • clasp clone <scriptId>
  • clasp pull
  • clasp push
  • clasp open
  • clasp deployments
  • clasp deploy [version] [description]
  • clasp redeploy <deploymentId> <description>
  • clasp version [description]
  • clasp versions

How To...

Login/Logout

clasp login
clasp logout

Create a New Apps Script Project

Files in the current directory are added to the project.

clasp create [scriptTitle]

Clone an existing project in the current directory

clasp clone <scriptId>

Push/Pull

clasp push # Updates Apps Script project with local files
clasp pull # Updates local files with Apps Script project

Update a Published Project / Deploy

To deploy a project:

  1. Create an immutable version of the Apps Script project using clasp version
  2. Deploy the version using clasp deploy [version]
clasp versions # List versions
clasp version [description] # Create a new version with a description

then deploy...

clasp deploy [version] [description]
clasp undeploy <deploymentId>
clasp deployments # List all deployment IDs

Open the project on script.google.com

clasp open

Troubleshooting

The library requires Node version >= 4.7.4.

node -v # Check Node version
sudo npm install n -g
sudo n latest

Develop

To develop the Apps Script SDK locally, install the CLI locally:

sudo npm i -g
clasp <command>

Bump versions and publish with:

npm publish --access public

⚑ Powered by the Apps Script API.

clasp's People

Contributors

grant avatar nirazul avatar sqrrrl avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.