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 edea4a71..741e3b09 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 @@ -5,14 +5,13 @@ slug: /slack-cli/guides/installing-the-slack-cli-for-mac-and-linux # Installing the Slack CLI for Mac & Linux - The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools. ✨ **If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance. ⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**. -:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.] +:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.] If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version. @@ -32,6 +31,7 @@ the runtime environment for workflow apps. If you have VSCode installed, the [VSCode Deno extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) will be installed. +
Optional: Use an alias for the Slack CLI binary @@ -61,14 +61,17 @@ If you don't rename the slack binary to a different name, the installation scrip There are two optional flags available to customize the installation. 1. Specify a version you'd like to install using the version flag, `-v`. The absence of this flag will ensure the latest Slack CLI version is installed. + ``` curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -v 2.1.0 ``` 2. Skip the Deno installation by using the `-d` flag, like this: + ``` curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -d ``` +
@@ -140,12 +143,12 @@ $ slack doctor If you have upgraded your CLI version but your `deno-slack-hooks` version is less than `v1.3.0`, when running `slack doctor`, you will see the following near the end of the output: ``` -✔ Configurations (your project's CLI settings) + ✔ Configurations (your project's CLI settings) Project ID: 1a2b3c4d-ef5g-67hi-8j9k1l2m3n4o ✘ Runtime (foundations for the application) Error: The `doctor` hook was not found (sdk_hook_not_found) - Suggestion: Ensure this hook is implemented in your `slack.json` + Suggestion: Debug responses from the Slack hooks file (.slack/hooks.json) ✔ Dependencies (requisites for development) deno_slack_hooks: 1.2.3 → 1.3.0 (supported version) @@ -156,10 +159,13 @@ In addition, if you attempt to run the `slack run` command without this dependen ``` 🚫 The `start` script was not found (sdk_hook_not_found) - 💡 Suggestion - Hook scripts are defined in the Slack configuration file ('slack.json'). - Every app requires a 'slack.json' file and you can find a working example at: - https://github.com/slack-samples/deno-starter-template/blob/main/slack.json +💡 Suggestion + Hook scripts are defined in one of these Slack hooks files: + - slack.json + - .slack/hooks.json + + Every app requires a Slack hooks file and you can find a working example at: + https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json ``` diff --git a/docs/guides/installing-the-slack-cli-for-windows.md b/docs/guides/installing-the-slack-cli-for-windows.md index ca4ac1de..035d471b 100644 --- a/docs/guides/installing-the-slack-cli-for-windows.md +++ b/docs/guides/installing-the-slack-cli-for-windows.md @@ -5,14 +5,13 @@ slug: /slack-cli/guides/installing-the-slack-cli-for-windows # Installing the Slack CLI for Windows - The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools. ✨ **If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance. ⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**. -:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.] +:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.] If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version. @@ -128,6 +127,7 @@ If you have another CLI tool in your path called `slack`, we recommend renaming ::: **6\. Verify that** `slack` **is installed and in your path:** + ``` $ slack version Using slack v3.5.1 @@ -136,6 +136,7 @@ Using slack v3.5.1 **7\. Verify that all dependencies have been installed.** Run the following command: + ``` $ slack doctor ``` @@ -150,7 +151,7 @@ If you have upgraded your CLI version but your `deno-slack-hooks` version is les ✘ Runtime (foundations for the application) Error: The `doctor` hook was not found (sdk_hook_not_found) - Suggestion: Ensure this hook is implemented in your `slack.json` + Suggestion: Debug responses from the Slack hooks file (.slack/hooks.json) ✔ Dependencies (requisites for development) deno_slack_hooks: 1.2.3 → 1.3.0 (supported version) @@ -159,18 +160,20 @@ If you have upgraded your CLI version but your `deno-slack-hooks` version is les In addition, if you attempt to run the `slack run` command without this dependency installed, you will see a similar error in your console: ``` - 🚫 The `start` script was not found (sdk_hook_not_found) +🚫 The `start` script was not found (sdk_hook_not_found) + +💡 Suggestion + Hook scripts are defined in one of these Slack hooks files: + - slack.json + - .slack/hooks.json - 💡 Suggestion - Hook scripts are defined in the Slack configuration file ('slack.json'). - Every app requires a 'slack.json' file and you can find a working example at: - https://github.com/slack-samples/deno-starter-template/blob/main/slack.json + Every app requires a Slack hooks file and you can find a working example at: + https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json ``` Ensure that `deno-slack-hooks` is installed at the project level and that the version is not less than `v1.3.0`. -**8\. [Install the VSCode extension for - Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).** +**8\. [Install the VSCode extension for Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).** diff --git a/internal/slackerror/errors.go b/internal/slackerror/errors.go index 409295f5..9db12b24 100644 --- a/internal/slackerror/errors.go +++ b/internal/slackerror/errors.go @@ -1332,7 +1332,7 @@ Otherwise start your app for local development with: %s`, "- " + filepath.Join(".slack", "hooks.json"), "", "Every app requires a Slack hooks file and you can find an example at:", - style.Highlight("https://github.com/slack-samples/deno-starter-template/blob/main/slack.json"), + style.Highlight("https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json"), "", "You can create a hooks file manually or with the " + style.Commandf("init", false) + " command.", "",