Note: This post was originally published in our community forum.
Looking to supercharge your Google Apps Script development? Meet CLASP—Command Line Apps Script, the tool that lets you write and manage your Google Apps Script projects locally on your computer, with the power of version control and modern development practices.
In this quick guide, we’ll walk you through the steps to get CLASP up and running, so you can start coding like a pro in no time!
Step 1: Install Node.js and NPM
Before you can install CLASP, you need to have Node.js and NPM (Node Package Manager) installed on your machine.1. Download and Install Node.js
- Go to theNode.js official websiteand download the latest stable version for your operating system.
- Follow the installation prompts, and make sure NPM is installed along with Node.js. NPM usually comes bundled with Node.js, so you should be all set once the installation is complete.
2. Verify the Installation
- Open your command line interface (CLI) and type the following commands to check if Node.js and NPM are installed: bashnode -v npm -v
- If installed correctly, both commands should return version numbers.
Step 2: Install CLASP
Now that Node.js and NPM are installed, you can install CLASP globally on your machine.1. Install CLASP
- In your CLI, type the following command: bash npm install -g @google/clasp
- This command installs CLASP globally, allowing you to use it from anywhere on your system.
2. Verify the Installation
- To confirm that CLASP is installed correctly, run the following command: bash clasp -v
- You should see the version number of CLASP, indicating a successful installation.
Step 3: Set Up Google Apps Script Project
Now that CLASP is installed, you can set up your Google Apps Script project.1. Authenticate CLASP with Your Google Account
- Run the following command to log in with your Google account: bash clasp login
- This will open a browser window asking you to authenticate CLASP with your Google account. Follow the prompts to allow access.
2. Create a New Google Apps Script Project
- To create a new project, navigate to your desired directory in the CLI and run: bash clasp create –title “My New Project” –type standalone
- Replace `“My New Project”` with your desired project name. The `–type standalone` flag indicates that this is a standalone script, not bound to any particular Google Document, Spreadsheet, or Form.
3. Pull an Existing Google Apps Script Project (Optional)
- If you already have a Google Apps Script project and want to work on it locally, use: bash clasp clone YOUR_SCRIPT_ID
- Replace `YOUR_SCRIPT_ID` with the script ID of your project. This pulls the project to your local machine.
Step 4: Start Coding and Pushing Changes
With your project set up, you can now start coding locally and push your changes back to Google Apps Script.1. Write Your Code Locally
- Use your favorite code editor (like VS Code) to write your Apps Script code. The files are typically saved as `.gs` (Google Script) or `.js` (JavaScript) files.
2. Push Changes to Google Apps Script
- After making changes locally, you can push them to Google Apps Script by running: bash clasp push
- This command uploads your local changes to the Google Apps Script editor.
3. Pull Changes from Google Apps Script
- If you’ve made changes directly in the Google Apps Script editor, pull those changes to your local environment with: bash clasp pull
- This ensures that your local files are up-to-date with the latest changes.
Step 5: Deploy Your Script
Once you’re happy with your script, you can deploy it directly using CLASP.1. Deploy as a Web App
- To deploy your script as a web app, use the following command: bash clasp deploy –description “Initial deployment”
- This deploys the latest version of your script and gives you a deployment URL.
2. Manage Deployments
- To view all deployments or update an existing deployment, use: bash clasp deployments
- This command shows all active deployments and their URLs.
