diff --git a/docs/guides/installing-the-slack-cli-for-mac-and-linux.md b/docs/guides/installing-the-slack-cli-for-mac-and-linux.md index 939c0ddc..34bc93b8 100644 --- a/docs/guides/installing-the-slack-cli-for-mac-and-linux.md +++ b/docs/guides/installing-the-slack-cli-for-mac-and-linux.md @@ -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.** @@ -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 ``` diff --git a/docs/guides/installing-the-slack-cli-for-windows.md b/docs/guides/installing-the-slack-cli-for-windows.md index 1a58f2fe..55468275 100644 --- a/docs/guides/installing-the-slack-cli-for-windows.md +++ b/docs/guides/installing-the-slack-cli-for-windows.md @@ -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.** -   Windows (.zip) +   Windows (.zip) **3\. Add the** `slack` **CLI to your path.** @@ -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 ``` diff --git a/docs/reference/commands/slack.md b/docs/reference/commands/slack.md index ca9e5dd4..109252fd 100644 --- a/docs/reference/commands/slack.md +++ b/docs/reference/commands/slack.md @@ -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 @@ -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 diff --git a/docs/reference/commands/slack_create.md b/docs/reference/commands/slack_create.md index 8309a70a..2503099d 100644 --- a/docs/reference/commands/slack_create.md +++ b/docs/reference/commands/slack_create.md @@ -20,6 +20,7 @@ slack create [name | agent ] [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 ``` @@ -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 diff --git a/docs/reference/commands/slack_docs.md b/docs/reference/commands/slack_docs.md new file mode 100644 index 00000000..dc71cb07 --- /dev/null +++ b/docs/reference/commands/slack_docs.md @@ -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 + diff --git a/docs/reference/commands/slack_init.md b/docs/reference/commands/slack_init.md index b5ad131a..cc1c2bda 100644 --- a/docs/reference/commands/slack_init.md +++ b/docs/reference/commands/slack_init.md @@ -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 diff --git a/docs/reference/commands/slack_project_create.md b/docs/reference/commands/slack_project_create.md index 3296133d..da4f7a66 100644 --- a/docs/reference/commands/slack_project_create.md +++ b/docs/reference/commands/slack_project_create.md @@ -20,6 +20,7 @@ slack project create [name | agent ] [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 ``` @@ -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 diff --git a/docs/reference/commands/slack_project_init.md b/docs/reference/commands/slack_project_init.md index 607d3a1e..e4e11785 100644 --- a/docs/reference/commands/slack_project_init.md +++ b/docs/reference/commands/slack_project_init.md @@ -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 diff --git a/docs/reference/errors.md b/docs/reference/errors.md index 0f982b0f..530ad6bc 100644 --- a/docs/reference/errors.md +++ b/docs/reference/errors.md @@ -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 ""` + +--- + ### documentation_generation_failed {#documentation_generation_failed} **Message**: Failed to generate documentation @@ -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