Running slack help
displays the following usage summary in your terminal window:
USAGE
$ slack <command> <subcommand> [flags]
COMMANDS
auth
info View your active workspace authorization
list List all authorized workspaces
login Login to a new or inactive workspace
logout Log out of a workspace
cloud
activity Print app activity
deploy Deploy the Slack app
run Develop and run locally
collaborator
add Add a collaborator to your app
list List all collaborators of an app
remove Remove a collaborator from an app
datastore
delete Delete an item from a datstore
get Get an item from a datastore
put Create or update an item in a datastore
query Query a datastore for items
env
add Add an environment variable to the app
list List all environment variables for the app
remove Remove an environment variable from the app
external-auth
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
remove Remove token(s) for your app in the current Slack team
function
distribute Manage who can view functions published by your app
manifest
info Displays the app manifest when run in a valid project directory
validate Validates the app manifest generated from a valid project directory
trigger
access Manage who can run your triggers
create Create a trigger for a workflow
delete Deletes an existing trigger
info Get details for a specific trigger
list List details of triggers declared in a valid project directory
update Fully updates an existing trigger
workspace
install Install the app to a workspace
list List all workspaces that installed the app
uninstall Uninstalls the app from a workspace
create Create a Slack project
deno Runs deno command with DENO_AUTH_TOKENS mapped to Slack workspace tokens
doctor Checks and reports on relevant system dependencies
feedback Share feedback about your experience
help Help about any command
upgrade Check available updates for the CLI and SDK
version Print the version number
FLAGS
--apihost string Slack API host
-f, --force Ignore warnings and continue executing command
-h, --help Help for Slack
-l, --local-run run Use the local run app created by the run command
--no-prompt Use promptless version of command, if supported
-r, --runtime string Project's runtime language: deno, deno1.1, deno1.x,
etc. (Default: deno)
-s, --skip-update Skip checking for latest version of CLI
--slackdev Use the Slack Dev API (--apihost=dev.slack.com)
-v, --verbose When set print debug logging
-w, --workspace string Use a specific workspace by domain name
✨ For more details about how to use flags, check out global flags.
⤵️ For some of the most commonly-used commands, refer to the table below:
Command | Description |
---|---|
slack login |
The first step in creating a new app is to authorize your CLI to your workspace. Refer to authorize the CLI. |
slack auth list |
You are ready to start developing your Slack app when you see that your workspace has an ACTIVE label in the output of this command. Refer to verify workspace authentication. |
slack create <app-name> |
Use this command, along with the name for your app, to create a new app. Refer to create an app. |
slack trigger create --trigger-def <path/to/trigger.ts> |
Create a trigger for your app. Refer to the triggers overview to learn more about the different types: link, scheduled, event, and webhook. |
slack trigger -list |
View information about your app's triggers, including the trigger ID, name, type, creation, and last updated time. You'll be prompted to select the workspace and environment (either local or deployed) for the triggers to list. |
slack run |
Run your app on a local development server. Refer to using slack run. |
slack run --show-triggers |
View triggers created in your local development environment (triggers created in the deployed enviornment will not be listed). |
slack deploy |
Deploy your app to production. Refer to using slack deploy. |
slack uninstall |
Uninstall an app from your workspace. You'll be prompted to choose your workspace first; then you can choose the app you want to remove. Refer to uninstall an app from your workspace. |
slack var add |
Add environment variables (deployed apps only). Variable keys and values are encrypted before storing them. |
slack var list |
View environment variables. For more details, refer to using environment variables. |
Have 2 minutes to provide some feedback?
We'd love to hear about your experience building modular Slack apps. Please complete our short survey so we can use your feedback to improve.