Commands

The command line interface allows you to interact with your apps via the command line. Using the main command slack, you can create, run, and deploy apps, as well as create triggers, and query datastores.

The following is a comprehensive guide to the Slack CLI commands and each command's respective parameters and flags. Each category below is a Slack command and each item under it is a subcommand, so you would use them like so (unless otherwise noted):

  slack <command> <subcommand> [flags]

To view global flags and each subcommand's flags, run the following in your terminal:

  slack <subcommand> --help

Global flags

Auth

Add and remove local workspace authorizations.

list

List all authorized workspaces.

login

Log in to a new or inactive workspace.

logout

Log out of a workspace.

Collaborator

Manage app collaborators.

add

Add a collaborator to your app by Slack email address or user ID.

slack collaborator add <email|user_id> [flags]

list

List all collaborators of an app.

remove

Remove a collaborator from an app by Slack email address or user ID.

slack collaborator remove <email|user_id> [flags]

Datastore

Query an App Datastore. Useful for auditing your datastore and testing your queries.

delete

Delete an item from a datastore.

slack datastore delete <query> [flags]

$ slack datastore delete '{ "datastore": "running_datastore", "id": "50" }'

🎉  Deleted from datastore: running_datastore

primary_key: 50
To inspect the datastore after updates, run slack datastore query [expression]

get

Get an item from a datastore.

slack datastore get <query> [flags]

$ slack datastore get '{ "datastore": "running_datastore", "id": "50" }'

🎉  Get from Datastore: running_datastore

{
  "distance": 26.2,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To inspect the datastore after updates, run slack datastore get [expression]

put

Create or replace an item in a datastore. Will overwrite entire datastore item.

slack datastore put [item details] [flags]

// datastores/run_data.ts 
import { DefineDatastore, Schema } from "deno-slack-sdk/mod.ts";

export const RUN_DATASTORE = "running_datastore";

const RunningDatastore = DefineDatastore({
  name: RUN_DATASTORE,
  primary_key: "id",
  attributes: {
    id: {
      type: Schema.types.string,
    },
    runner: {
      type: Schema.slack.types.user_id,
    },
    distance: {
      type: Schema.types.number,
    },
    rundate: {
      type: Schema.slack.types.date,
    },
  },
});

export default RunningDatastore;

slack datastore put '{ "datastore": "running_datastore", "item": { "id": "50", "runner": "ABCD1234EFG", "distance": "26.2", "rundate": "2023-03-19"} }'

🎉  Stored below record in the datastore: running_datastore

{
  "distance": 26.2,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To inspect the datastore after updates, run slack datastore query [expression]

query

Query a datastore for items.

slack datastore query [expression] [flags]

$ slack datastore query '{ "datastore": "running_datastore", "expression": "rundate = :rundate", "expression_values": {":rundate": "2023-03-19"} }'

🎉  Retrieved 1 items from datastore: running_datastore

{
  "distance": 26.3,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To create or update existing items run slack datastore put [item]

slack datastore query '{"datastore": "running_datastore"}'

update

Create or update an item in a datastore. Will only overwrite specified individual fields.

$ slack datastore update '{ "app_id": "UVW987XYZ65", "datastore": "running_datastore", "item": { "id": "50", "runner": "ABCD1234EFG", "distance": "26.3", "rundate": "2023-03-19"} }'

🎉  Stored below record in the datastore: running_datastore

{
  "distance": 26.3,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To inspect the datastore after updates, run slack datastore query [expression]

Env

Add, remove, and list environment variables. Note this is for deployed apps only. To store local environment variables, use the .env file.

add

Add an environment variable to the app, prompting for a name or value if none is provided.

slack env add [name] [value] [flags]

list

List all environment variables for the app.

remove

Remove an environment variable from the app, selecting from set variables if none is provided.

slack env remove [name] [flags]

External-auth

Add and remove external authorizations and client secrets for providers in your app.

add

Initiate the Oauth2 flow for a provider in your app for the current Slack team.

add-secret

Add client secret for a provider in your app for the current Slack team that will be used to initiate the auth flow.

slack external-auth add-secret --provider provider_key --secret client_secret [flags]

remove

Remove token(s) for your app and optionally providers in the current Slack team. Note that this command will not revoke existing tokens. You might be able to revoke them from a provider's dev console or APIs.

Function

Manage who can view and use functions.

distribute

Manage who can view functions published by your app.

Manifest

Displays app manifest when run in a valid project directory.

info

Displays the app manifest when run in a valid project directory.

validate

Validates the app manifest generated from a valid project directory.

Platform

Access Slack Platform.

activity

Print logging info from your app.

deploy

Deploys the Slack app.

run

Develop and run locally with live updates in your workspace.

Trigger

List details of triggers declared in a valid project directory.

access

Manage who can run your triggers.

slack trigger access --trigger-id <id> [flags]

create

Creates a trigger which can be used to initiate a workflow execution.

slack trigger create --workflow <reference> [flags]

delete

Deletes an existing trigger.

slack trigger delete --trigger-id <id> [flags]

info

Get details for a specific trigger.

slack trigger info --trigger-id <id> [flags]

list

List details of triggers declared in a valid project directory.

update

Fully updates an existing trigger with the updated definition. Only supports full replacement, no partial update.

slack trigger update --trigger-id <id> --workflow <reference> [flags]

Workspace

Install, uninstall, and list workspaces that installed the app.

delete

Uninstalls the app from the team workspace and deletes the app manifest from the Slack API.

install

Install the app to a workspace.

list

List all workspaces that installed the app.

Create

Create a Slack project on your local machine with an optional template.

slack create [name] [flags]

Deno

Runs deno command with DENO_AUTH_TOKENS mapped to Slack workspace tokens. The deno command is a bit different than the others listed here. This is how you use it:

    deno [OPTIONS] [SUBCOMMAND]

The flags for each subcommand can be found by running the following in your terminal window:

slack deno <subcommand> --help

The Slack CLI and Deno support the standard, proxy-related environment variables. Proxy configuration is read from the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY. To use these variables, ensure you have the minimum Deno version of 1.28. You can check which version you have by running slack deno --version in your terminal window. All of the supported environment variables are listed here:

Doctor

Checks and reports on relevant system dependencies.

Feedback

Help us make the next generation platform better by completing the feedback survey.

Help

Help provides help for any command in the application. Simply type slack help [path to command] for full details.

Samples

List and create an app from the available samples.

Upgrade

Checks available updates for the CLI and SDK.

Version

All software has versions. This is ours.

✨ To start creating an app, check out the create or remove an app page.