Commands

The command line interface allows you to interact with your next generation apps via the command line.

The following is a comprehensive guide to the Slack CLI commands, subcommands, and their respective parameters and flags. Use commands 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

Overview

Global flags

App

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

delete

Uninstall the app from the workspace or organization and permanently delete the app and all of its data.

install

Install the app to a workspace.

list

List all workspaces that have installed the app.

Auth

Add and remove local workspace authorizations.

list

List all authorized accounts.

login

Log in to a Slack account.

logout

Log out of a workspace.

revoke

Delete a service token.

token

Get the slackauthticket to copy and paste into your workspace to exchange for the service token.

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]

Create

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

slack create [name] [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" }'

slack datastore delete ('{"datastore":"running_datastore", "id":"50"}' | ConvertTo-JSON)

🎉  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" }'

slack datastore get ('{"datastore":"running_datastore", "id":"50"}' | ConvertTo-JSON)

🎉  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"} }'

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

🎉  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 an app's datastore.

slack datastore query [expression] [flags]

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

slack datastore query ('{"datastore":"running_datastore", "expression":"rundate = :rundate", "expression_values":{":rundate":"2023-03-19"} }' | ConvertTo-JSON)

🎉  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"}'

slack datastore query ('{"datastore": "running_datastore"}' | ConvertTo-JSON)

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"} }'

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

🎉  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]

Deno

Run a deno command, evaluate a script, or create a REPL environment. Workspace tokens will be mapped to the DENO_AUTH_TOKENS environment variable.

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

Check and report on relevant system (and sometimes app) dependencies.

Env

Add, remove, and list environment variables.

This command 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.

add-secret

Add the client secret for a provider in your app. This secret will be used when initiating the OAuth2 flow

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

remove

Remove provider token(s) stored by your app.

Note: Existing tokens are only removed from your app, but not revoked! Tokens may be revoked from the provider's developer console or via APIs.

select-auth

Select a unique auth for each of the workflows in your app.

Feedback

Help us make the Slack Platform better by completing the feedback survey.

Function

Manage who can view and use functions.

distribute

Manage who can view functions published by your app.

Help

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

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

Deploy and run apps on the Slack Platform.

activity

Display the app activity logs from the Slack Platform.

deploy

Deploy the app to the Slack Platform.

run

Start a local server to develop and run the app locally while watching for file changes.

Samples

List and create an app from the available samples.

Trigger

List details of existing triggers.

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 existing triggers.

update

Updates an existing trigger with the provided definition. Only supports full replacement, no partial update.

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

Upgrade

Checks for available updates to the CLI or the SDKs of a project. If there are any, then you will be prompted to upgrade.

Changes between versions are logged at the Slack next generation changelog.

Version

All software has versions. This is ours.

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