Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/guides/installing-the-slack-cli-for-mac-and-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ Manual installation allows you to customize certain paths used when installing t

**2\. Download the** `slack` **CLI installer for your environment.**

🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.15.0_macOS_arm64.tar.gz)
🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_4.0.0_macOS_arm64.tar.gz)

🍏 🪨 [**Download for macOS Intel (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.15.0_macOS_amd64.tar.gz)
🍏 🪨 [**Download for macOS Intel (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_4.0.0_macOS_amd64.tar.gz)

🐧 💾 [**Download for Linux (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.15.0_linux_64-bit.tar.gz)
🐧 💾 [**Download for Linux (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_4.0.0_linux_64-bit.tar.gz)

**3\. Add the** `slack` **CLI to your path.**

Expand All @@ -121,7 +121,7 @@ We recommend using an alias if another `slack` binary exists. To do this, change

```sh
$ slack version
Using slack v3.15.0
Using slack v4.0.0
```

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/installing-the-slack-cli-for-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Manual installation allows you to customize certain paths used when installing t

**2\. Download the** `slack` **CLI installer for your environment.**

<ts-icon class="ts_icon_windows"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.15.0_windows_64-bit.zip"><strong>Windows (.zip)</strong></a>
<ts-icon class="ts_icon_windows"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_4.0.0_windows_64-bit.zip"><strong>Windows (.zip)</strong></a>

**3\. Add the** `slack` **CLI to your path.**

Expand All @@ -104,7 +104,7 @@ We recommend using an alias if another `slack` binary exists. To do this, change

```pwsh
$ slack version
Using slack v3.15.0
Using slack v4.0.0
```

</TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ $ slack docs # Open Slack developer docs
* [slack deploy](slack_deploy) - Deploy the app to the Slack Platform
* [slack docs](slack_docs) - Open Slack developer docs
* [slack doctor](slack_doctor) - Check and report on system and app information
* [slack env](slack_env) - Add, remove, or list environment variables
* [slack env](slack_env) - Set, unset, or list environment variables
* [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers
* [slack feedback](slack_feedback) - Share feedback about your experience or project
* [slack function](slack_function) - Manage the functions of an app
Expand Down
15 changes: 9 additions & 6 deletions docs/reference/commands/slack_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Open Slack developer docs

## Description

Open the Slack developer docs in your browser, with optional search functionality
Open the Slack developer docs in your browser or search them using the search subcommand

```
slack docs [flags]
Expand All @@ -13,8 +13,7 @@ slack docs [flags]
## Flags

```
-h, --help help for docs
--search open Slack docs search page or search with query
-h, --help help for docs
```

## Global flags
Expand All @@ -34,14 +33,18 @@ slack docs [flags]
## Examples

```
$ slack docs # Open Slack developer docs homepage
# Open Slack developer docs homepage
$ slack docs

# Search Slack developer docs for Block Kit
$ slack docs --search "Block Kit"
$ slack docs --search # Open Slack docs search page
$ slack docs search "Block Kit"

# Search docs and open results in browser
$ slack docs search "Block Kit" --output=browser
```

## See also

* [slack](slack) - Slack command-line tool
* [slack docs search](slack_docs_search) - Search Slack developer docs

52 changes: 52 additions & 0 deletions docs/reference/commands/slack_docs_search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# `slack docs search`

Search Slack developer docs

## Description

Search the Slack developer docs and return results in text, JSON, or browser
format.

```
slack docs search [query] [flags]
```

## Flags

```
-h, --help help for search
--limit int maximum number of text or json search results to return (default 20)
--output string output format: text, json, browser (default "text")
```

## Global flags

```
-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

```
# Search docs and return text results
$ slack docs search "Block Kit"

# Search docs and open results in browser
$ slack docs search "webhooks" --output=browser

# Search docs with limited JSON results
$ slack docs search "api" --output=json --limit=5
```

## See also

* [slack docs](slack_docs) - Open Slack developer docs

24 changes: 12 additions & 12 deletions docs/reference/commands/slack_env.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# `slack env`

Add, remove, or list environment variables
Set, unset, or list environment variables

## Description

Add, remove, or list environment variables for apps deployed to Slack managed
infrastructure.
Set, unset, or list environment variables for the project.

This command is supported for apps deployed to Slack managed infrastructure but
other apps can attempt to run the command with the --force flag.
Commands that run in the context of a project source environment variables from
the ".env" file. This includes the "run" command.

The "deploy" command gathers environment variables from the ".env" file as well
unless the app is using ROSI features.

Explore more: [https://docs.slack.dev/tools/slack-cli/guides/using-environment-variables-with-the-slack-cli](https://docs.slack.dev/tools/slack-cli/guides/using-environment-variables-with-the-slack-cli)

Expand Down Expand Up @@ -39,19 +41,17 @@ slack env <subcommand> [flags]
## Examples

```
$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable
$ slack env set MAGIC_PASSWORD abracadbra # Set an environment variable

# List all environment variables
$ slack env list

# Remove an environment variable
$ slack env remove MAGIC_PASSWORD
$ slack env unset MAGIC_PASSWORD # Unset an environment variable
```

## See also

* [slack](slack) - Slack command-line tool
* [slack env add](slack_env_add) - Add an environment variable to the app
* [slack env list](slack_env_list) - List all environment variables for the app
* [slack env remove](slack_env_remove) - Remove an environment variable from the app
* [slack env list](slack_env_list) - List all environment variables of the project
* [slack env set](slack_env_set) - Set an environment variable for the project
* [slack env unset](slack_env_unset) - Unset an environment variable from the project

14 changes: 8 additions & 6 deletions docs/reference/commands/slack_env_list.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# `slack env list`

List all environment variables for the app
List all environment variables of the project

## Description

List all of the environment variables of an app deployed to Slack managed
infrastructure.
List the environment variables available to the project.

This command is supported for apps deployed to Slack managed infrastructure but
other apps can attempt to run the command with the --force flag.
Commands that run in the context of a project source environment variables from
the ".env" file. This includes the "run" command.

The "deploy" command gathers environment variables from the ".env" file as well
unless the app is using ROSI features.

```
slack env list [flags]
Expand Down Expand Up @@ -42,5 +44,5 @@ $ slack env list # List all environment variables

## See also

* [slack env](slack_env) - Add, remove, or list environment variables
* [slack env](slack_env) - Set, unset, or list environment variables

Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# `slack env add`
# `slack env set`

Add an environment variable to the app
Set an environment variable for the project

## Description

Add an environment variable to an app deployed to Slack managed infrastructure.
Set an environment variable for the project.

If a name or value is not provided, you will be prompted to provide these.

This command is supported for apps deployed to Slack managed infrastructure but
other apps can attempt to run the command with the --force flag.
Commands that run in the context of a project source environment variables from
the ".env" file. This includes the "run" command.

The "deploy" command gathers environment variables from the ".env" file as well
unless the app is using ROSI features.

```
slack env add <name> <value> [flags]
slack env set [name] [value] [flags]
```

## Flags

```
-h, --help help for add
-h, --help help for set
--value string set the environment variable value
```

Expand All @@ -40,14 +43,14 @@ slack env add <name> <value> [flags]

```
# Prompt for an environment variable
$ slack env add
$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable
$ slack env set
$ slack env set MAGIC_PASSWORD abracadbra # Set an environment variable

# Prompt for an environment variable value
$ slack env add SECRET_PASSWORD
$ slack env set SECRET_PASSWORD
```

## See also

* [slack env](slack_env) - Add, remove, or list environment variables
* [slack env](slack_env) - Set, unset, or list environment variables

Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
# `slack env remove`
# `slack env unset`

Remove an environment variable from the app
Unset an environment variable from the project

## Description

Remove an environment variable from an app deployed to Slack managed
infrastructure.
Unset an environment variable from the project.

If no variable name is provided, you will be prompted to select one.

This command is supported for apps deployed to Slack managed infrastructure but
other apps can attempt to run the command with the --force flag.
Commands that run in the context of a project source environment variables from
the ".env" file. This includes the "run" command.

The "deploy" command gathers environment variables from the ".env" file as well
unless the app is using ROSI features.

```
slack env remove <name> [flags]
slack env unset [name] [flags]
```

## Flags

```
-h, --help help for remove
-h, --help help for unset
--name string choose the environment variable name
```

Expand All @@ -40,12 +42,12 @@ slack env remove <name> [flags]
## Examples

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

## See also

* [slack env](slack_env) - Add, remove, or list environment variables
* [slack env](slack_env) - Set, unset, or list environment variables

9 changes: 4 additions & 5 deletions docs/reference/commands/slack_platform_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Start a local server to develop and run the app locally
Start a local server to develop and run the app locally while watching for file changes

```
slack platform run [flags]
slack platform run [app-file-path] [flags]
```

## Flags
Expand Down Expand Up @@ -39,11 +39,10 @@ slack platform run [flags]
## Examples

```
# Start a local development server
$ slack platform run
$ slack platform run # Start a local development server

# Run a local development server with debug activity
$ slack platform run --activity-level debug
# 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
Expand Down
9 changes: 4 additions & 5 deletions docs/reference/commands/slack_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Start a local server to develop and run the app locally
Start a local server to develop and run the app locally while watching for file changes

```
slack run [flags]
slack run [app-file-path] [flags]
```

## Flags
Expand Down Expand Up @@ -39,11 +39,10 @@ slack run [flags]
## Examples

```
# Start a local development server
$ slack platform run
$ slack platform run # Start a local development server

# Run a local development server with debug activity
$ slack platform run --activity-level debug
# 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
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/commands/slack_sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,7 @@ slack sandbox <subcommand> [flags] --experiment=sandboxes
## See also

* [slack](slack) - Slack command-line tool
* [slack sandbox create](slack_sandbox_create) - Create a developer sandbox
* [slack sandbox delete](slack_sandbox_delete) - Delete a developer sandbox
* [slack sandbox list](slack_sandbox_list) - List developer sandboxes

Loading
Loading