Slack CLI

https://docs.slack.dev/tools/slack-cli/
Admin
The Slack command-line interface (CLI) allows you to create and manage Slack apps from the command...
Tokens:55,853
Snippets:856
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### slack app install examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_install

Common usage examples for installing production and local development apps to specific teams.

```bash
# Install a production app to a team$ slack app install# Install a production app to a specific team$ slack app install --team T0123456 --environment deployed# Install a local dev app to a specific team$ slack app install --team T0123456 --environment local
```

--------------------------------

### slack platform run examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_run

Common usage examples for starting the local development server, including custom entry points and cleanup options.

```bash
$ slack platform run               # Start a local development server# Run a local development server with a custom app entry point$ slack platform run ./src/app.py# Run a local development server with cleanup$ slack platform run --cleanup
```

--------------------------------

### Example: Initialize a project

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_init

Example command to initialize a project.

```bash
$ slack init  # Initialize a project
```

--------------------------------

### Run Installer with Custom Flags

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-windows

Example of running the local installer script using the -Version, -Alias, and -SkipGit flags.

```powershell
.\install-windows.ps1 -Version 2.1.0 -Alias slackcli -SkipGit $true
```

--------------------------------

### slack app list example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_list

Example command to list all teams with the app installed.

```bash
$ slack app list  # List all teams with the app installed
```

--------------------------------

### slack manifest examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_manifest

Examples showing how to display and validate an app manifest.

```bash
# Display the app manifest for the current project$ slack manifest info# Validate the app manifest generated by a project$ slack manifest validate
```

--------------------------------

### Example usage

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_link

Examples showing how to link an app interactively or by providing specific flags.

```bash
# Add an existing app to a project$ slack app link# Add a specific app without using prompts$ slack app link --team T0123456789 --app A0123456789 --environment deployed
```

--------------------------------

### slack datastore get examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_get

Examples showing how to retrieve an item from the 'tasks' datastore using either the --datastore flag or a full JSON expression.

```bash
# Get an item from the datastore$ slack datastore get --datastore tasks '{"id": "42"}'# Get an item from the datastore with an expression$ slack datastore get '{"datastore": "tasks", "id": "42"}'
```

--------------------------------

### Initialize environment variables example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_env_init

Example of running the slack env init command.

```bash
$ slack env init  # Initialize environment variables from a template file
```

--------------------------------

### Examples of slack deploy

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_deploy

Examples showing how to deploy to a workspace or a specific team.

```bash
# Select the workspace to deploy to$ slack platform deploy$ slack platform deploy --team T0123456  # Deploy to a specific team
```

--------------------------------

### slack env set usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_env_set

Examples showing how to prompt for variables or set them directly.

```bash
# Prompt for an environment variable$ slack env set$ slack env set MAGIC_PASSWORD abracadbra  # Set an environment variable# Prompt for an environment variable value$ slack env set SECRET_PASSWORD
```

--------------------------------

### Example of slack env list

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_env_list

An example command to list all environment variables.

```bash
$ slack env list  # List all environment variables
```

--------------------------------

### Validate manifest example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_manifest_validate

An example of how to run the validation command for a project.

```bash
# Validate the app manifest generated by a project$ slack manifest validate
```

--------------------------------

### Preview examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_blocks_preview

Examples showing how to preview blocks passed as a flag, read from a file, or redirected with a team scope.

```bash
# Preview blocks passed as a flag value$ slack blocks preview --blocks '[{"type":"divider"}]'# Preview blocks read from a file$ slack blocks preview < blocks.json# Preview blocks read from a redirect and scoped to a team$ slack blocks preview --team T0123456 --blocks - < blocks.json
```

--------------------------------

### Query examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_query

Examples showing how to collect limited items, use cursors, and filter by expressions.

```bash
# Collect a limited set of items from the datastore$ slack datastore query --datastore tasks '{"limit": 8}' --output json# Collect items from the datastore starting at a cursor$ slack datastore query --datastore tasks '{"cursor": "eyJfX2NWaV..."}'# Query the datastore for specific items$ slack datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}'# Query the datastore for specific items with only an expression$ slack datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}'
```

--------------------------------

### List all collaborators example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_collaborator_list

Example command to list all collaborators of an app.

```bash
$ slack collaborator list  # List all of the collaborators
```

--------------------------------

### slack platform usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_platform

Common examples for running, deploying, and monitoring apps using the slack platform command.

```bash
$ slack run                     # Run an app locally in a workspace$ slack deploy --team T0123456  # Deploy to a specific team$ slack activity -t             # Continuously poll for new activity logs
```

--------------------------------

### Slack datastore examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore

Common operations for interacting with a datastore, including put, bulk-put, update, get, bulk-get, delete, bulk-delete, query, and count.

```bash
# Add a new entry to the datastore$ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}'# Add two new entries to the datastore$ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}'# Update the entry in the datastore$ slack datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}'# Get an item from the datastore$ slack datastore get --datastore tasks '{"id": "42"}'# Get two items from datastore$ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}'# Remove an item from the datastore$ slack datastore delete --datastore tasks '{"id": "42"}'# Remove two items from the datastore$ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}'# Query the datastore for specific items$ slack datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}'# Count number of items in datastore$ slack datastore count --datastore tasks
```

--------------------------------

### slack create usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_create

Common examples for creating projects, including using templates, naming apps, and linking to existing environments.

```bash
# Create a new project from a template$ slack create my-project# Create a new AI Agent app$ slack create agent my-agent-app# Start a new project from a specific template$ slack create my-project -t slack-samples/deno-hello-world# Create a project named 'my-project'$ slack create --name my-project# Create from a subdirectory of a template$ slack create my-project -t org/monorepo --subdir apps/my-app# Create from template and link to an existing app$ slack create my-project -t slack-samples/bolt-js-starter-template --app A0123456789 --environment local
```

--------------------------------

### slack function distribution examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_function

Examples showing how to distribute functions and look up distribution information.

```bash
# Select a function and choose distribution options$ slack function distribute# Distribute a function to everyone in a workspace$ slack function distribute --name callback_id --everyone# Lookup the distribution information for a function$ slack function distribute --info
```

--------------------------------

### Check for updates example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_upgrade

Example command to check for any available updates.

```bash
$ slack upgrade  # Check for any available updates
```

--------------------------------

### Run the automated Slack CLI installer

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux

Executes the automated installation script to install the Slack CLI and configure the command.

```bash
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash
```

--------------------------------

### slack docs examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_docs

Examples for opening the homepage, searching for specific topics, and opening search results in a browser.

```bash
# Open Slack developer docs homepage$ slack docs# Search Slack developer docs for Block Kit$ slack docs search "Block Kit"# Search docs and open results in browser$ slack docs search "Block Kit" --output=browser
```

--------------------------------

### slack app install command syntax

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_install

The basic syntax for the slack app install command.

```bash
slack app install [flags]
```

--------------------------------

### Examples of adding datastore entries

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_put

Examples showing how to add a new entry to a datastore using either the --datastore flag or a full JSON expression.

```bash
# Add a new entry to the datastore$ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}'# Add a new entry to the datastore with an expression$ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}'
```

--------------------------------

### slack manifest info usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_manifest_info

Examples showing how to print the manifest from local configurations, a specific app ID, or remote app settings.

```bash
# Print the app manifest from project configurations$ slack manifest info# Print the remote manifest of an app$ slack manifest info --app A0123456789# Print the app manifest gathered from App Config$ slack manifest info --source remote
```

--------------------------------

### Count items in a datastore examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_count

Examples showing how to count all items in a datastore and how to count items matching a specific query expression.

```bash
# Count all items in a datastore$ slack datastore count --datastore tasks# Count number of items in datastore that match a query$ slack datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}'
```

--------------------------------

### slack collaborator usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_collaborator

Examples for adding, listing, and removing collaborators.

```bash
$ slack collaborator add bots@slack.com  # Add a collaborator from email$ slack collaborator list                # List all of the collaborators# Remove a collaborator by user ID$ slack collaborator remove USLACKBOT
```

--------------------------------

### slack datastore bulk-get examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_bulk-get

Examples of retrieving items from a datastore using the --datastore flag or a JSON expression.

```bash
# Get two items from datastore$ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}'# Get two items from datastore with an expression$ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}'
```

--------------------------------

### slack auth usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_auth

Common examples for listing, logging in, and logging out of Slack accounts.

```bash
$ slack auth list    # List all authorized accounts$ slack auth login   # Log in to a Slack account$ slack auth logout  # Log out of a team
```

--------------------------------

### Select developer authentication example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_external-auth_select-auth

Example command to select saved developer authentication for a specific workflow.

```bash
# Select the saved developer authentication in a workflow$ slack external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com
```

--------------------------------

### Run Automated Installer

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-windows

Execute the automated installer script directly from the Slack edge download source.

```powershell
irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 | iex
```

--------------------------------

### slack activity usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_activity

Examples of displaying app activity logs and enabling continuous polling.

```bash
$ slack platform activity     # Display app activity logs for an app$ slack platform activity -t  # Continuously poll for new activity logs
```

--------------------------------

### slack datastore bulk-put examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_bulk-put

Examples of creating or replacing entries in a datastore using the bulk-put command.

```bash
# Create or replace two new entries in the datastore$ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}'# Create or replace two new entries in the datastore with an expression$ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}'
```

--------------------------------

### View Available Installer Flags

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-windows

Pass the -? flag to the local installer script to list all available customization options.

```powershell
.\install-windows.ps1 -?
```

--------------------------------

### slack project samples usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_project_samples

Examples showing how to list Bolt for JavaScript samples and how to initiate the creation of a new project.

```bash
$ slack samples --list --language node  # List Bolt for JavaScript samples$ slack samples my-project              # Select a sample app to create
```

--------------------------------

### slack trigger info usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_trigger_info

Examples showing how to retrieve trigger details in a selected workspace and how to specify an app ID.

```bash
# Get details for a specific trigger in a selected workspace$ slack trigger info --trigger-id Ft01234ABCD# Get details for a specific trigger$ slack trigger info --trigger-id Ft01234ABCD --app A0123456
```

--------------------------------

### Install PowerShell 7

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-windows

Run this command in PowerShell to install PowerShell 7, which is a prerequisite for the Slack CLI.

```powershell
iex "& { $(irm https://aka.ms/install-powershell.ps1) } -UseMSI"
```

--------------------------------

### Examples of initiating OAuth2 flow

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_external-auth_add

Shows how to initiate the OAuth2 flow by selecting a provider or by specifying a provider key directly.

```bash
# Select a provider to initiate the OAuth2 flow for$ slack external-auth add# Initiate the OAuth2 flow for the provided provider$ slack external-auth add -p github
```

--------------------------------

### Uninstall an app from a team example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_uninstall

Example command to uninstall an app from a team.

```bash
$ slack app uninstall  # Uninstall an app from a team
```

--------------------------------

### slack feedback usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_feedback

Examples of how to run the feedback command to provide input on the Slack Platform or the Slack CLI.

```bash
# Choose to give feedback on part of the Slack Platform$ slack feedback$ slack feedback --name slack-cli  # Give feedback on the Slack CLI
```

--------------------------------

### Examples of slack sandbox list

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_sandbox_list

Common usage examples for listing all sandboxes or filtering by active status.

```bash
$ slack sandbox list                  # List developer sandboxes$ slack sandbox list --status active  # List active sandboxes only
```

--------------------------------

### Common slack app command examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app

Examples of various operations available under the slack app command.

```bash
$ slack app install    # Install a production app to a team$ slack app link       # Link an existing app to the project$ slack app list       # List all teams with the app installed$ slack app settings   # Open app settings in a web browser$ slack app uninstall  # Uninstall an app from a team$ slack app unlink     # Remove a linked app from the project$ slack app delete     # Delete an app and app info from a team
```

--------------------------------

### Examples of slack app settings

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_settings

Demonstrates opening the settings dashboard generally or for a specific application ID.

```bash
$ slack app settings                    # Open app settings dashboard# Open app settings for a specific app$ slack app settings --app A0123456789
```

--------------------------------

### Examples of slack trigger list

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_trigger_list

Examples showing how to list all triggers or filter triggers for a specific app and team.

```bash
# List details for all existing triggers$ slack trigger list# List triggers for a specific app$ slack trigger list --team T0123456 --app local
```

--------------------------------

### Install with version and alias flags

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux

Combines the version flag and a custom alias when running the automated installer.

```bash
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -v 2.1.0 <your-preferred-alias>
```

--------------------------------

### slack auth logout usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_auth_logout

Examples showing how to log out of a selected team or all teams.

```bash
$ slack auth logout        # Select a team to log out of$ slack auth logout --all  # Log out of all team
```

--------------------------------

### Deploy using a service token

Source: https://docs.slack.dev/tools/slack-cli/guides/authorizing-the-slack-cli

Example of using the --token global flag with the deploy command.

```bash
slack deploy --token <your-service-token>
```

--------------------------------

### API command examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_api

Common examples of using the slack api command for various Slack platform operations.

```bash
# Test your API connection$ slack api api.test# Check authentication$ slack api auth.test# Add a bookmark to a channel$ slack api bookmarks.add channel_id=C0123456 title=Docs link=https://example.com# Send a message to a channel using form-encoded string$ slack api chat.postMessage channel=C0123456 text="Hello"# Send a message to a channel using JSON$ slack api chat.postMessage --json '{"channel":"C0123456","text":"Hello"}'# Update a message$ slack api chat.update channel=C0123456 ts=1234567890.123456 text="Updated"# Create a channel$ slack api conversations.create name=new-channel# Fetch messages from a channel$ slack api conversations.history channel=C0123456# Get channel details$ slack api conversations.info channel=C0123456# List channels$ slack api conversations.list# List members in a channel$ slack api conversations.members channel=C0123456# Upload a file$ slack api files.upload channels=C0123456 filename=report.csv# Pin a message$ slack api pins.add channel=C0123456 timestamp=1234567890.123456# Add an emoji reaction$ slack api reactions.add channel=C0123456 timestamp=1234567890.123456 name=thumbsup# List reactions for a user$ slack api reactions.list user=U0123456# Get user details$ slack api users.info user=U0123456# List workspace members$ slack api users.list# Get a user's profile$ slack api users.profile.get user=U0123456# Validate Block Kit blocks (no auth required)$ slack api blocks.validate --no-auth blocks='[{"type":"section","text":{"type":"mrkdwn","text":"Hello"}}]'# Open a modal view$ slack api views.open trigger_id=T0123456 view={...}# Update a modal view$ slack api views.update view_id=V0123456 view={...}
```

--------------------------------

### Examples of slack manifest diff

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_manifest_diff

Shows how to run the command to compare manifest differences, including an example using specific app and token flags.

```bash
# Show differences between project manifest and app settings$ slack manifest diff# Show manifest differences without prompts$ slack manifest diff --app A0123456789 --token xoxp-...
```

--------------------------------

### Update datastore entry examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_update

Examples showing how to update a datastore entry using the --datastore flag or a full JSON expression.

```bash
# Update the entry in the datastore$ slack datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}'# Update the entry in the datastore with an expression$ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}'
```

--------------------------------

### slack collaborator add usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_collaborator_add

Examples of adding a collaborator via prompt, email, or user ID.

```bash
$ slack collaborator add                # Add a collaborator via prompt$ slack collaborator add bot@slack.com  # Add a collaborator from email$ slack collaborator add USLACKBOT      # Add a collaborator by user ID
```

--------------------------------

### slack trigger create examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_trigger_create

Common usage examples for creating triggers, including interactive selection, definition files, and direct workflow references.

```bash
# Create a trigger by selecting an app and trigger definition$ slack trigger create# Create a trigger from a definition file$ slack trigger create --trigger-def "triggers/shortcut_trigger.ts"# Create a trigger for a workflow$ slack trigger create --workflow "#/workflows/my_workflow"
```

--------------------------------

### slack external-auth usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_external-auth

Common examples for managing external authentication providers, including adding, removing, and selecting authorization.

```bash
# Initiate OAuth2 flow for a selected provider$ slack external-auth add# Set client secret for an app and provider$ slack external-auth add-secret# Remove authorization for a specific provider$ slack external-auth remove# Select authorization for a specific provider in a workflow$ slack external-auth select-auth
```

--------------------------------

### Example: Generate status report

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_doctor

Example of running the doctor command to generate a status report of system dependencies.

```bash
$ slack doctor  # Create a status report of system dependencies
```

--------------------------------

### Download Installer for Custom Flags

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-windows

Download the automated installer script to a local file to allow passing custom flags.

```powershell
irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 -outfile 'install-windows.ps1'
```

--------------------------------

### Create a symbolic link for manual installation

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux

Links the downloaded Slack CLI binary to a directory already in the system PATH.

```bash
ln -s "$HOME/.slack/bin/slack" "$HOME/.local/bin/slack"
```

--------------------------------

### slack auth token examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_auth_token

Examples of using slack auth token with and without prompts, and completing authentication with a ticket and challenge code.

```bash
# Create a service token with prompts$ slack auth token# Gather a service token without prompts, this returns a ticket$ slack auth token --no-prompt# Complete authentication using a ticket and challenge code$ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0...
```

--------------------------------

### slack app unlink examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_unlink

Examples showing how to remove an app from a project, including using a specific app ID.

```bash
# Remove an existing app from the project$ slack app unlink# Remove a specific app without using prompts$ slack app unlink --app A0123456789
```

--------------------------------

### slack datastore bulk-delete examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_bulk-delete

Examples showing how to delete items from a datastore using the --datastore flag or a JSON expression.

```bash
# Delete two items from the datastore$ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}'# Delete two items from the datastore with an expression$ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}'
```

--------------------------------

### slack trigger update examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_trigger_update

Examples showing how to update a trigger using a definition file or by specifying a workflow ID and title.

```bash
# Update a trigger definition with a selected file$ slack trigger update --trigger-id Ft01234ABCD# Update a trigger with a workflow id and title$ slack trigger update --trigger-id Ft01234ABCD \    --workflow "#/workflows/my_workflow" --title "Updated trigger"
```

--------------------------------

### Preview blocks in Block Kit Builder

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_blocks

Example command to preview a divider block in the Block Kit Builder.

```bash
# Preview blocks in Block Kit Builder$ slack blocks preview --blocks '[{"type":"divider"}]'
```

--------------------------------

### slack env unset examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_env_unset

Examples showing how to unset an environment variable, either by selecting from a prompt or by specifying the name directly.

```bash
# Select an environment variable to unset$ slack env unset$ slack env unset MAGIC_PASSWORD  # Unset an environment variable
```

--------------------------------

### Perform initial manual deployment

Source: https://docs.slack.dev/tools/slack-cli/guides/deploying-the-slack-cli-with-github-actions

Deploy the app to your workspace for the first time to verify the workflow.

```bash
slack deploy
```

--------------------------------

### slack env usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_env

Common operations including initializing, setting, listing, and unsetting environment variables.

```bash
# Initialize environment variables from a template file$ slack env init$ slack env set MAGIC_PASSWORD abracadbra  # Set an environment variable# List all environment variables$ slack env list$ slack env unset MAGIC_PASSWORD           # Unset an environment variable
```

--------------------------------

### Basic slack app request command

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_request

The standard syntax for checking app installation requests.

```bash
slack app request [flags]
```

--------------------------------

### Common Slack CLI commands

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack

Examples of frequently used commands for managing Slack apps.

```bash
$ slack login   # Log in to your Slack account$ slack create  # Create a new Slack app$ slack init    # Initialize an existing Slack app$ slack run     # Start a local development server$ slack deploy  # Deploy to the Slack Platform$ slack docs    # Open Slack developer docs
```

--------------------------------

### slack version usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_version

Common ways to invoke the version command or flag, including skipping update checks.

```bash
$ slack version                  # Print version number using the command$ slack --version                # Print version number using the flag$ slack --version --skip-update  # Print version and skip update check
```

--------------------------------

### slack trigger access examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_trigger_access

Examples of granting and revoking access to triggers.

```bash
# Grant everyone access to run a trigger$ slack trigger access --trigger-id Ft01234ABCD --everyone# Grant certain channels access to run a trigger$ slack trigger access --trigger-id Ft01234ABCD --grant \    --channels C012345678# Revoke certain users access to run a trigger$ slack trigger access --trigger-id Ft01234ABCD --revoke \    --users USLACKBOT,U012345678
```

--------------------------------

### slack auth login usage examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_auth_login

Common usage patterns for the login command, including interactive and non-interactive authentication methods.

```bash
# Login to a Slack account with prompts$ slack auth login# Login to a Slack account without prompts, this returns a ticket$ slack auth login --no-prompt# Complete login using ticket and challenge code$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0...# Login with a user token$ slack auth login --token xoxp-...
```

--------------------------------

### Revoke a service token example

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_auth_revoke

Example of revoking a specific service token.

```bash
$ slack auth revoke --token xoxp-1-4921830...  # Revoke a service token
```

--------------------------------

### Initialize a project

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_init

Basic usage of the slack init command to initialize a project.

```bash
slack init [flags]
```

--------------------------------

### slack trigger delete examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_trigger_delete

Examples showing how to delete a trigger in a workspace and for a specific app.

```bash
# Delete a specific trigger in a selected workspace$ slack trigger delete --trigger-id Ft01234ABCD# Delete a specific trigger for an app$ slack trigger delete --trigger-id Ft01234ABCD --app A0123456
```

--------------------------------

### slack project samples command syntax

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_project_samples

The basic syntax for listing or creating a project from a sample.

```bash
slack project samples [name] [flags]
```

--------------------------------

### slack external-auth add-secret examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_external-auth_add-secret

Examples of how to input or set the client secret for an app and provider.

```bash
# Input the client secret for an app and provider$ slack external-auth add-secret# Set the client secret for an app and provider$ slack external-auth add-secret -p github -x ghp_token
```

--------------------------------

### Examples of creating sandboxes

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_sandbox_create

Common patterns for creating sandboxes, including standard creation, temporary sandboxes with TTL, and sandboxes with specific archive dates.

```bash
# Create a sandbox named test-box$ slack sandbox create --name test-box --password mypass# Create a temporary sandbox that will be archived in 1 day$ slack sandbox create --name test-box --password mypass --domain test-box --archive-ttl 1d# Create a sandbox that will be archived on a specific date$ slack sandbox create --name test-box --password mypass --domain test-box --archive-date 2025-12-31
```

--------------------------------

### Initialize environment variables flags

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_env_init

Displays the help flag available for the init command.

```bash
  -h, --help   help for init
```

--------------------------------

### Verify Slack CLI installation

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux

Checks that the Slack CLI is correctly installed and accessible in the system path.

```bash
$ slack versionUsing slack v4.7.0
```

--------------------------------

### Install a specific version

Source: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux

Pins the installation to a specific version of the Slack CLI using the -v flag.

```bash
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -v 2.1.0
```

--------------------------------

### slack collaborator remove examples

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_collaborator_remove

Examples of removing a collaborator via prompt, email, or user ID.

```bash
$ slack collaborator remove                # Remove collaborator on prompt$ slack collaborator remove bot@slack.com  # Remove collaborator by email$ slack collaborator remove USLACKBOT      # Remove collaborator using ID
```

--------------------------------

### Basic command usage

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_query

The standard syntax for querying a datastore.

```bash
slack datastore query <expression> [flags]
```

--------------------------------

### Basic command usage

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_link

The standard syntax for linking an existing app to the current project.

```bash
slack app link [flags]
```

--------------------------------

### slack app install

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_install

Installs the Slack app to a team. This command supports flags for specifying the environment and target workspace.

```APIDOC
## slack app install

### Description
Install the app to a team.

### Usage
`slack app install [flags]`

### Flags
- **-E, --environment** (string) - Environment of app (local, deployed)
- **-h, --help** - Help for install
- **--org-workspace-grant** (string) - Grant access to a specific org workspace ID (or 'all' for all workspaces in the org)

### Global Flags
- **--accessible** - Use accessible prompts for screen readers
- **-a, --app** (string) - Use a specific app ID or environment
- **--config-dir** (string) - Use a custom path for system config directory
- **-e, --experiment** (strings) - Use the experiment(s) in the command
- **-f, --force** - Ignore warnings and continue executing command
- **--no-color** - Remove styles and formatting from outputs
- **-s, --skip-update** - Skip checking for latest version of CLI
- **-w, --team** (string) - Select workspace or organization by team name or ID
- **--token** (string) - Set the access token associated with a team
- **-v, --verbose** - Print debug logging and additional info

### Examples
- Install a production app to a team: `slack app install`
- Install a production app to a specific team: `slack app install --team T0123456 --environment deployed`
- Install a local dev app to a specific team: `slack app install --team T0123456 --environment local`
```

--------------------------------

### Basic usage of slack sandbox create

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_sandbox_create

Create a new sandbox with a specified name and password.

```bash
slack sandbox create [flags]
```

--------------------------------

### Create a new Slack app project

Source: https://docs.slack.dev/tools/slack-cli/guides/deploying-the-slack-cli-with-github-actions

Run this command to initialize a new Slack app project using the Slack CLI.

```bash
slack create
```

--------------------------------

### slack datastore get flags

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_datastore_get

Available flags for the datastore get command, including datastore selection and output formatting.

```bash
      --datastore string   the datastore used to store items  -h, --help               help for get      --output string      output format: text, json (default "text")      --show               only construct a JSON expression      --unstable           kick the tires of experimental features
```

--------------------------------

### slack project create command syntax

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_project_create

The basic syntax for creating a new Slack project, including the optional agent shortcut.

```bash
slack project create [name | agent <name>] [flags]
```

--------------------------------

### slack app install flags

Source: https://docs.slack.dev/tools/slack-cli/reference/commands/slack_app_install

Available flags for the slack app install command, including environment selection and organization workspace grants.

```bash
  -E, --environment string           environment of app (local, deployed)  -h, --help                         help for install      --org-workspace-grant string   grant access to a specific org workspace ID                                       (or 'all' for all workspaces in the org)
```
Tokens:
Raw