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.13.0_macOS_arm64.tar.gz)
🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.14.0_macOS_arm64.tar.gz)

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

🐧 💾 [**Download for Linux (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.13.0_linux_64-bit.tar.gz)
🐧 💾 [**Download for Linux (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.14.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.13.0
Using slack v3.14.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.13.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_3.14.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.13.0
Using slack v3.14.0
```

</TabItem>
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/commands/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ $ 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
```

## See also
Expand All @@ -47,6 +48,7 @@ $ slack deploy # Deploy to the Slack Platform
* [slack datastore](slack_datastore) - Interact with an app's datastore
* [slack delete](slack_delete) - Delete the app
* [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 external-auth](slack_external-auth) - Adjust settings of external authentication providers
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/commands/slack_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ slack create [name | agent <name>] [flags]
-h, --help help for create
--list list available app templates
-n, --name string name for your app (overrides the name argument)
--subdir string subdirectory in the template to use as project
-t, --template string template URL for your app
```

Expand Down Expand Up @@ -51,6 +52,9 @@ $ 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
```

## See also
Expand Down
47 changes: 47 additions & 0 deletions docs/reference/commands/slack_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# `slack docs`

Open Slack developer docs

## Description

Open the Slack developer docs in your browser, with optional search functionality

```
slack docs [flags]
```

## Flags

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

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

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

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

## See also

* [slack](slack) - Slack command-line tool

2 changes: 1 addition & 1 deletion docs/reference/commands/slack_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Adds the Slack CLI hooks dependency to your project:
Installs your project dependencies when supported:
- Deno: Supported
- Node.js: Supported
- Python: Unsupported
- Python: Supported

Adds an existing app to your project (optional):
- Prompts to add an existing app from app settings
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/commands/slack_project_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ slack project create [name | agent <name>] [flags]
-h, --help help for create
--list list available app templates
-n, --name string name for your app (overrides the name argument)
--subdir string subdirectory in the template to use as project
-t, --template string template URL for your app
```

Expand Down Expand Up @@ -51,6 +52,9 @@ $ 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
```

## See also
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_project_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Adds the Slack CLI hooks dependency to your project:
Installs your project dependencies when supported:
- Deno: Supported
- Node.js: Supported
- Python: Unsupported
- Python: Supported

Adds an existing app to your project (optional):
- Prompts to add an existing app from app settings
Expand Down
14 changes: 14 additions & 0 deletions docs/reference/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,14 @@ Approval is pending review

---

### docs_search_flag_required {#docs_search_flag_required}

**Message**: Invalid docs command. Did you mean to search?

**Remediation**: Use --search flag: `slack docs --search "<query>"`

---

### documentation_generation_failed {#documentation_generation_failed}

**Message**: Failed to generate documentation
Expand Down Expand Up @@ -1354,6 +1362,12 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again.

---

### subdir_not_found {#subdir_not_found}

**Message**: The specified subdirectory was not found in the template repository

---

### survey_config_not_found {#survey_config_not_found}

**Message**: Survey config not found
Expand Down
Loading