clasp run [functionName]
allows you to execute Apps Script functions remotely.
To use clasp run
, you need to complete 4 steps:
- Set up a Project ID.
- Create an OAuth Client ID (Other). Download as
creds.json
. clasp login --creds creds.json
with this downloaded file.- Add the following to
appsscript.json
:"executionApi": { "access": "ANYONE" }
- Ensure you have upgraded to the latest version
clasp -v
- Add a
projectId
to your.clasp.json
. You can find your Project ID via:- Create a GCP project
- Record the
Project ID
andProject number
. (Example:my-sample-project-191923.
and314053285323
) - Run the command with your
Project ID
:clasp setting projectId <PROJECT_ID>
- Set the
projectId
to your Apps Script project- Open
https://console.developers.google.com/apis/credentials/consent?project=[PROJECT_ID]
- Set
Application name
toclasp project
and clicksave
. clasp open
- In the menu, click
Resources > Cloud Platform project...
- Paste
Project number
inChange Project
and clickSet Project
- Open
- Use your own OAuth 2 client. Create one by following these instructions:
clasp open --creds
- Press Create credentials > OAuth client ID
- Application type: Other
- Create > OK
- Download the file (⬇), move it to your directory, and name it
creds.json
. Please keep this file secret!
- Call
clasp login --creds creds.json
After setup, you can remotely execute Apps Script functions from clasp
:
clasp push
your files.- Type
clasp run
. You'll be prompted for which function you want to run. Select and press Enter. - The result is displayed in the output.
- You can also run functions directly. i.e.
clasp run helloWorld
.
Many Apps Script functions require special OAuth Scopes (Gmail, Drive, etc.).
To run functions that use these scopes, you must add the scopes to your Apps Script manifest and clasp login
again.
clasp open
File > Project Properties > Scopes
- Add these scopes to your
appsscript.json
. - Log in again:
clasp login --creds creds.json
. This will add these scopes to your credentials. clasp run sendMail