diff --git a/docs/reference/commands/slack.md b/docs/reference/commands/slack.md index 0bb3f6c4..76129eaa 100644 --- a/docs/reference/commands/slack.md +++ b/docs/reference/commands/slack.md @@ -6,7 +6,7 @@ Slack command-line tool CLI to create, run, and deploy Slack apps -Get started by reading the docs: [https://tools.slack.dev/deno-slack-sdk](/deno-slack-sdk) +Get started by reading the docs: [https://tools.slack.dev/slack-cli](https://tools.slack.dev/slack-cli) ``` slack [flags] diff --git a/docs/reference/commands/slack_app.md b/docs/reference/commands/slack_app.md index acdbd450..9ba020e9 100644 --- a/docs/reference/commands/slack_app.md +++ b/docs/reference/commands/slack_app.md @@ -13,11 +13,12 @@ slack app [flags] ### Examples ``` -$ slack install # Install a production app to a team -$ slack link # Link an existing app to the project -$ slack list # List all teams with the app installed -$ slack uninstall # Uninstall an app from a team -$ slack delete # Delete an app and app info from a team +$ 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 delete # Delete an app and app info from a team ``` ### Options @@ -47,5 +48,6 @@ $ slack delete # Delete an app and app info from a team * [slack app install](slack_app_install) - Install the app to a team * [slack app link](slack_app_link) - Add an existing app to the project * [slack app list](slack_app_list) - List teams with the app installed +* [slack app settings](slack_app_settings) - Open app settings for configurations * [slack app uninstall](slack_app_uninstall) - Uninstall the app from a team diff --git a/docs/reference/commands/slack_app_settings.md b/docs/reference/commands/slack_app_settings.md new file mode 100644 index 00000000..7f34eaf2 --- /dev/null +++ b/docs/reference/commands/slack_app_settings.md @@ -0,0 +1,51 @@ +## slack app settings + +Open app settings for configurations + +### Synopsis + +Open app settings to configure an application in a web browser. + +Discovering new features and customizing an app manifest can be done from this +web interface for apps with a "remote" manifest source. + +This command does not support apps deployed to Run on Slack infrastructure. + +``` +slack app settings [flags] +``` + +### Examples + +``` +# Open app settings for a prompted app +$ slack app settings + +# Open app settings for a specific app +$ slack app settings --app A0123456789 +``` + +### Options + +``` + -h, --help help for settings +``` + +### Options inherited from parent commands + +``` + -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 +``` + +### SEE ALSO + +* [slack app](slack_app) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slack_env.md b/docs/reference/commands/slack_env.md index 0b388b6d..47b84f40 100644 --- a/docs/reference/commands/slack_env.md +++ b/docs/reference/commands/slack_env.md @@ -10,7 +10,7 @@ infrastructure. This command is supported for apps deployed to Slack managed infrastructure but other apps can attempt to run the command with the --force flag. -Explore more: [Environment variables](/slack-cli/guides/using-environment-variables-with-the-slack-cli) +Explore more: [https://tools.slack.dev/slack-cli/guides/using-environment-variables-with-the-slack-cli](https://tools.slack.dev/slack-cli/guides/using-environment-variables-with-the-slack-cli) ``` slack env [flags] diff --git a/docs/reference/commands/slack_external-auth.md b/docs/reference/commands/slack_external-auth.md index b6e42167..0ff5636f 100644 --- a/docs/reference/commands/slack_external-auth.md +++ b/docs/reference/commands/slack_external-auth.md @@ -9,7 +9,7 @@ Adjust external authorization and authentication providers of a workflow app. This command is supported for apps deployed to Slack managed infrastructure but other apps can attempt to run the command with the --force flag. -Explore providers: [Integrating with external auth providers](/guides/integrating-with-services-requiring-external-authentication/) +Explore providers: [https://tools.slack.dev/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication](https://tools.slack.dev/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication) ``` slack external-auth [flags] diff --git a/docs/reference/commands/slack_feedback.md b/docs/reference/commands/slack_feedback.md index 663d111e..12401439 100644 --- a/docs/reference/commands/slack_feedback.md +++ b/docs/reference/commands/slack_feedback.md @@ -13,7 +13,9 @@ slack feedback [flags] ### Examples ``` +# Choose to give feedback on part of the Slack Platform $ slack feedback +$ slack feedback --name slack-cli # Give feedback on the Slack CLI ``` ### Options diff --git a/docs/reference/commands/slack_manifest.md b/docs/reference/commands/slack_manifest.md index 6035d014..426e837c 100644 --- a/docs/reference/commands/slack_manifest.md +++ b/docs/reference/commands/slack_manifest.md @@ -31,7 +31,7 @@ $ slack manifest validate ``` -h, --help help for manifest - --source string source of the app manifest ("local" or "remote") (default "local") + --source string source of the app manifest ("local" or "remote") ``` ### Options inherited from parent commands diff --git a/docs/reference/commands/slack_manifest_info.md b/docs/reference/commands/slack_manifest_info.md index 8309ec97..6c239ad8 100644 --- a/docs/reference/commands/slack_manifest_info.md +++ b/docs/reference/commands/slack_manifest_info.md @@ -32,7 +32,7 @@ $ slack manifest info --source remote ``` -h, --help help for info - --source string source of the app manifest ("local" or "remote") (default "local") + --source string source of the app manifest ("local" or "remote") ``` ### Options inherited from parent commands diff --git a/docs/reference/commands/slack_upgrade.md b/docs/reference/commands/slack_upgrade.md index 99858cbd..7c925897 100644 --- a/docs/reference/commands/slack_upgrade.md +++ b/docs/reference/commands/slack_upgrade.md @@ -8,7 +8,7 @@ Checks for available updates to the CLI or the SDKs of a project If there are any, then you will be prompted to upgrade -The changelog can be found at [https://docs.slack.dev/changelog/](https://docs.slack.dev/changelog/) +The changelog can be found at [https://docs.slack.dev/changelog](https://docs.slack.dev/changelog) ``` slack upgrade [flags] diff --git a/docs/reference/commands/slack_version.md b/docs/reference/commands/slack_version.md index 1bde289b..85d45e52 100644 --- a/docs/reference/commands/slack_version.md +++ b/docs/reference/commands/slack_version.md @@ -6,10 +6,38 @@ Print the version number All software has versions. This is ours. +Version numbers follow the semantic versioning specification (semver) +and are always prefixed with a `v`, such as `v3.0.1`. + +Given a version number MAJOR.MINOR.PATCH: + +1. MAJOR versions have incompatible, breaking changes +2. MINOR versions add functionality that is a backward compatible +3. PATCH versions make bug fixes that are backward compatible + +Experiments are patch version until officially released. + +Development builds use `git describe` and contain helpful info, +such as the prior release and specific commit of the build. + +Given a version number `v3.0.1-7-g822d09a`: + +1. `v3.0.1` is the version of the prior release +2. `7` is the number of commits ahead of the `v3.0.1` git tag +3. `g822d09a` is the git commit for this build, prefixed with `g` + ``` slack version [flags] ``` +### Examples + +``` +$ 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 +``` + ### Options ``` diff --git a/docs/reference/errors.md b/docs/reference/errors.md index 0dc696d7..57a6a613 100644 --- a/docs/reference/errors.md +++ b/docs/reference/errors.md @@ -97,9 +97,11 @@ and some ways to remediate them. **Message**: Deployment to Slack is not currently supported for apps with `runOnSlack` set as false -**Remediation**: Learn about building apps with the Deno Slack SDK: tools.slack.dev/deno-slack-sdk/ -If you are using a Bolt framework, deployment is supported under an experiment. -Add a deploy hook then run: `slack deploy --experiment=bolt` +**Remediation**: Learn about building apps with the Deno Slack SDK: + +https://tools.slack.dev/deno-slack-sdk + +If you are using a Bolt framework, add a deploy hook then run: `slack deploy` Otherwise start your app for local development with: `slack run` @@ -121,7 +123,7 @@ Otherwise start your app for local development with: `slack run` **Message**: The --app flag must be provided -**Remediation**: Choose a specific app with ``--app `` +**Remediation**: Choose a specific app with `--app ` --- @@ -131,6 +133,12 @@ Otherwise start your app for local development with: `slack run` --- +### app_hosted {#app_hosted} + +**Message**: App is configured for Run on Slack infrastructure + +--- + ### app_install_error {#app_install_error} **Message**: Couldn't install your app to a workspace @@ -319,7 +327,8 @@ Learn more: https://slack.com/help/articles/201980108-Add-people-to-a-channel **Message**: Couldn't auto-update this command-line tool -**Remediation**: You can manually install the latest version from http://localhost:3000/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux. +**Remediation**: You can manually install the latest version from: +https://tools.slack.dev/slack-cli --- @@ -407,6 +416,12 @@ Approval is pending review --- +### context_value_not_found {#context_value_not_found} + +**Message**: The context value could not be found + +--- + ### credentials_not_found {#credentials_not_found} **Message**: No authentication found for this team @@ -539,6 +554,23 @@ Approval is pending review --- +### feedback_name_invalid {#feedback_name_invalid} + +**Message**: The name of the feedback is invalid + +**Remediation**: View the feedback options with `slack feedback --help` + +--- + +### feedback_name_required {#feedback_name_required} + +**Message**: The name of the feedback is required + +**Remediation**: Please provide a `--name ` flag or remove the `--no-prompt` flag +View feedback options with `slack feedback --help` + +--- + ### file_rejected {#file_rejected} **Message**: Not an acceptable S3 file @@ -673,6 +705,8 @@ Approval is pending review **Remediation**: A valid Slack project includes the Slack hooks file: .slack/hooks.json +If this is a Slack project, you can initialize it with `slack init` + --- ### invalid_app_flag {#invalid_app_flag} @@ -680,7 +714,7 @@ Approval is pending review **Message**: The provided --app flag value is not valid **Remediation**: Specify the environment with --app local or --app deployed -Or choose a specific app with ``--app `` +Or choose a specific app with `--app ` --- @@ -1251,12 +1285,16 @@ Read about manifest sourcing with the `slack manifest info --help` command **Message**: A script in .slack/hooks.json was not found -**Remediation**: Hook scripts are defined in the Slack hooks file ('.slack/hooks.json'). -Every app requires a Slack hooks file and you can find a working example at: +**Remediation**: 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 an example at: +https://github.com/slack-samples/deno-starter-template/blob/main/slack.json -https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json +You can create a hooks file manually or with the `slack init` command. -After creating the hooks file, you must install related hook dependencies. +When manually creating the hooks file, you must install the hook dependencies. --- @@ -1338,7 +1376,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: The --team flag must be provided -**Remediation**: Choose a specific team with ``--team `` or ``--team `` +**Remediation**: Choose a specific team with `--team ` or `--team ` ---