From 21a442e85f2086500653e5fe544419731ddf6ae6 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Fri, 15 Aug 2025 12:24:51 -0700 Subject: [PATCH 1/4] adds files as test --- .../workflows/slack-cli-generate-docs.yaml | 43 ++++++++++ docs/reference/commands/slackk.md | 69 ++++++++++++++++ docs/reference/commands/slackk_activity.md | 60 ++++++++++++++ docs/reference/commands/slackk_app.md | 53 ++++++++++++ docs/reference/commands/slackk_app_delete.md | 46 +++++++++++ docs/reference/commands/slackk_app_install.md | 52 ++++++++++++ docs/reference/commands/slackk_app_link.md | 56 +++++++++++++ docs/reference/commands/slackk_app_list.md | 44 ++++++++++ .../reference/commands/slackk_app_settings.md | 51 ++++++++++++ .../commands/slackk_app_uninstall.md | 42 ++++++++++ docs/reference/commands/slackk_auth.md | 49 +++++++++++ docs/reference/commands/slackk_auth_list.md | 42 ++++++++++ docs/reference/commands/slackk_auth_login.md | 55 +++++++++++++ docs/reference/commands/slackk_auth_logout.md | 44 ++++++++++ docs/reference/commands/slackk_auth_revoke.md | 42 ++++++++++ docs/reference/commands/slackk_auth_token.md | 52 ++++++++++++ .../reference/commands/slackk_collaborator.md | 49 +++++++++++ .../commands/slackk_collaborator_add.md | 44 ++++++++++ .../commands/slackk_collaborator_list.md | 42 ++++++++++ .../commands/slackk_collaborator_remove.md | 45 +++++++++++ docs/reference/commands/slackk_create.md | 48 +++++++++++ docs/reference/commands/slackk_datastore.md | 81 +++++++++++++++++++ .../commands/slackk_datastore_bulk-delete.md | 52 ++++++++++++ .../commands/slackk_datastore_bulk-get.md | 53 ++++++++++++ .../commands/slackk_datastore_bulk-put.md | 53 ++++++++++++ .../commands/slackk_datastore_count.md | 53 ++++++++++++ .../commands/slackk_datastore_delete.md | 52 ++++++++++++ .../commands/slackk_datastore_get.md | 53 ++++++++++++ .../commands/slackk_datastore_put.md | 52 ++++++++++++ .../commands/slackk_datastore_query.md | 60 ++++++++++++++ .../commands/slackk_datastore_update.md | 52 ++++++++++++ docs/reference/commands/slackk_delete.md | 46 +++++++++++ docs/reference/commands/slackk_deploy.md | 47 +++++++++++ docs/reference/commands/slackk_doctor.md | 51 ++++++++++++ docs/reference/commands/slackk_env.md | 57 +++++++++++++ docs/reference/commands/slackk_env_add.md | 53 ++++++++++++ docs/reference/commands/slackk_env_list.md | 46 +++++++++++ docs/reference/commands/slackk_env_remove.md | 51 ++++++++++++ .../commands/slackk_external-auth.md | 61 ++++++++++++++ .../slackk_external-auth_add-secret.md | 53 ++++++++++++ .../commands/slackk_external-auth_add.md | 50 ++++++++++++ .../commands/slackk_external-auth_remove.md | 60 ++++++++++++++ .../slackk_external-auth_select-auth.md | 50 ++++++++++++ docs/reference/commands/slackk_feedback.md | 49 +++++++++++ docs/reference/commands/slackk_function.md | 56 +++++++++++++ .../commands/slackk_function_access.md | 70 ++++++++++++++++ docs/reference/commands/slackk_init.md | 62 ++++++++++++++ docs/reference/commands/slackk_install.md | 52 ++++++++++++ docs/reference/commands/slackk_list.md | 42 ++++++++++ docs/reference/commands/slackk_login.md | 55 +++++++++++++ docs/reference/commands/slackk_logout.md | 44 ++++++++++ docs/reference/commands/slackk_manifest.md | 56 +++++++++++++ .../commands/slackk_manifest_info.md | 55 +++++++++++++ .../commands/slackk_manifest_validate.md | 43 ++++++++++ docs/reference/commands/slackk_platform.md | 47 +++++++++++ .../commands/slackk_platform_activity.md | 60 ++++++++++++++ .../commands/slackk_platform_deploy.md | 47 +++++++++++ .../reference/commands/slackk_platform_run.md | 55 +++++++++++++ docs/reference/commands/slackk_project.md | 58 +++++++++++++ .../commands/slackk_project_create.md | 48 +++++++++++ .../reference/commands/slackk_project_init.md | 62 ++++++++++++++ .../commands/slackk_project_samples.md | 46 +++++++++++ docs/reference/commands/slackk_run.md | 55 +++++++++++++ docs/reference/commands/slackk_samples.md | 46 +++++++++++ docs/reference/commands/slackk_trigger.md | 62 ++++++++++++++ .../commands/slackk_trigger_access.md | 65 +++++++++++++++ .../commands/slackk_trigger_create.md | 67 +++++++++++++++ .../commands/slackk_trigger_delete.md | 47 +++++++++++ .../reference/commands/slackk_trigger_info.md | 47 +++++++++++ .../reference/commands/slackk_trigger_list.md | 48 +++++++++++ .../commands/slackk_trigger_update.md | 64 +++++++++++++++ docs/reference/commands/slackk_uninstall.md | 42 ++++++++++ docs/reference/commands/slackk_upgrade.md | 46 +++++++++++ docs/reference/commands/slackk_version.md | 64 +++++++++++++++ docs/reference/errors.md | 74 ++++++++--------- 75 files changed, 3911 insertions(+), 37 deletions(-) create mode 100644 .github/workflows/slack-cli-generate-docs.yaml create mode 100644 docs/reference/commands/slackk.md create mode 100644 docs/reference/commands/slackk_activity.md create mode 100644 docs/reference/commands/slackk_app.md create mode 100644 docs/reference/commands/slackk_app_delete.md create mode 100644 docs/reference/commands/slackk_app_install.md create mode 100644 docs/reference/commands/slackk_app_link.md create mode 100644 docs/reference/commands/slackk_app_list.md create mode 100644 docs/reference/commands/slackk_app_settings.md create mode 100644 docs/reference/commands/slackk_app_uninstall.md create mode 100644 docs/reference/commands/slackk_auth.md create mode 100644 docs/reference/commands/slackk_auth_list.md create mode 100644 docs/reference/commands/slackk_auth_login.md create mode 100644 docs/reference/commands/slackk_auth_logout.md create mode 100644 docs/reference/commands/slackk_auth_revoke.md create mode 100644 docs/reference/commands/slackk_auth_token.md create mode 100644 docs/reference/commands/slackk_collaborator.md create mode 100644 docs/reference/commands/slackk_collaborator_add.md create mode 100644 docs/reference/commands/slackk_collaborator_list.md create mode 100644 docs/reference/commands/slackk_collaborator_remove.md create mode 100644 docs/reference/commands/slackk_create.md create mode 100644 docs/reference/commands/slackk_datastore.md create mode 100644 docs/reference/commands/slackk_datastore_bulk-delete.md create mode 100644 docs/reference/commands/slackk_datastore_bulk-get.md create mode 100644 docs/reference/commands/slackk_datastore_bulk-put.md create mode 100644 docs/reference/commands/slackk_datastore_count.md create mode 100644 docs/reference/commands/slackk_datastore_delete.md create mode 100644 docs/reference/commands/slackk_datastore_get.md create mode 100644 docs/reference/commands/slackk_datastore_put.md create mode 100644 docs/reference/commands/slackk_datastore_query.md create mode 100644 docs/reference/commands/slackk_datastore_update.md create mode 100644 docs/reference/commands/slackk_delete.md create mode 100644 docs/reference/commands/slackk_deploy.md create mode 100644 docs/reference/commands/slackk_doctor.md create mode 100644 docs/reference/commands/slackk_env.md create mode 100644 docs/reference/commands/slackk_env_add.md create mode 100644 docs/reference/commands/slackk_env_list.md create mode 100644 docs/reference/commands/slackk_env_remove.md create mode 100644 docs/reference/commands/slackk_external-auth.md create mode 100644 docs/reference/commands/slackk_external-auth_add-secret.md create mode 100644 docs/reference/commands/slackk_external-auth_add.md create mode 100644 docs/reference/commands/slackk_external-auth_remove.md create mode 100644 docs/reference/commands/slackk_external-auth_select-auth.md create mode 100644 docs/reference/commands/slackk_feedback.md create mode 100644 docs/reference/commands/slackk_function.md create mode 100644 docs/reference/commands/slackk_function_access.md create mode 100644 docs/reference/commands/slackk_init.md create mode 100644 docs/reference/commands/slackk_install.md create mode 100644 docs/reference/commands/slackk_list.md create mode 100644 docs/reference/commands/slackk_login.md create mode 100644 docs/reference/commands/slackk_logout.md create mode 100644 docs/reference/commands/slackk_manifest.md create mode 100644 docs/reference/commands/slackk_manifest_info.md create mode 100644 docs/reference/commands/slackk_manifest_validate.md create mode 100644 docs/reference/commands/slackk_platform.md create mode 100644 docs/reference/commands/slackk_platform_activity.md create mode 100644 docs/reference/commands/slackk_platform_deploy.md create mode 100644 docs/reference/commands/slackk_platform_run.md create mode 100644 docs/reference/commands/slackk_project.md create mode 100644 docs/reference/commands/slackk_project_create.md create mode 100644 docs/reference/commands/slackk_project_init.md create mode 100644 docs/reference/commands/slackk_project_samples.md create mode 100644 docs/reference/commands/slackk_run.md create mode 100644 docs/reference/commands/slackk_samples.md create mode 100644 docs/reference/commands/slackk_trigger.md create mode 100644 docs/reference/commands/slackk_trigger_access.md create mode 100644 docs/reference/commands/slackk_trigger_create.md create mode 100644 docs/reference/commands/slackk_trigger_delete.md create mode 100644 docs/reference/commands/slackk_trigger_info.md create mode 100644 docs/reference/commands/slackk_trigger_list.md create mode 100644 docs/reference/commands/slackk_trigger_update.md create mode 100644 docs/reference/commands/slackk_uninstall.md create mode 100644 docs/reference/commands/slackk_upgrade.md create mode 100644 docs/reference/commands/slackk_version.md diff --git a/.github/workflows/slack-cli-generate-docs.yaml b/.github/workflows/slack-cli-generate-docs.yaml new file mode 100644 index 00000000..75fcaa88 --- /dev/null +++ b/.github/workflows/slack-cli-generate-docs.yaml @@ -0,0 +1,43 @@ +name: Generate Slack CLI Docs + +on: + workflow_dispatch: + +jobs: + update-docs: + runs-on: ubuntu-latest + + steps: + + - name: Install Slack CLI + run: | + curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash + + - name: Generate a GitHub token + id: ghtoken + uses: actions/create-github-app-token@v2 + with: + app-id: ${{ secrets.GH_APP_ID }} + owner: slackapi + private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} + + - name: Checkout code + uses: actions/checkout@v4 + + - name: Generate docs + run: | + slack docgen content/slack-cli/reference + + - name: Create a pull request + uses: peter-evans/create-pull-request@v7 + with: + token: ${{ steps.ghtoken.outputs.token }} + title: "Automated Slack CLI reference docs for release" + body: "Automatically updating Slack CLI docs following release" + author: "slackapi[bot] <186980925+slackapi[bot]@users.noreply.github.com>" + committer: "slackapi[bot] <186980925+slackapi[bot]@users.noreply.github.com>" + commit-message: "Update slack cli reference docs" + base: "main" + branch: "update-slack-cli-reference" + delete-branch: true + labels: docs \ No newline at end of file diff --git a/docs/reference/commands/slackk.md b/docs/reference/commands/slackk.md new file mode 100644 index 00000000..1c3ce605 --- /dev/null +++ b/docs/reference/commands/slackk.md @@ -0,0 +1,69 @@ +## slackk + +Slack command-line tool + +### Synopsis + +{{Emoji "sparkles"}}CLI to create, run, and deploy Slack apps + +{{Emoji "books"}}Get started by reading the docs: {{LinkText "https://docs.slack.dev/tools/slack-cli"}} + +``` +slackk [flags] +``` + +### Examples + +``` +$ slackk login # Log in to your Slack account +$ slackk create # Create a new Slack app +$ slackk init # Initialize an existing Slack app +$ slackk run # Start a local development server +$ slackk deploy # Deploy to the Slack Platform +``` + +### Options + +``` + -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 + -h, --help help for slackk + --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 + +* [slackk activity](slackk_activity.md) - Display the app activity logs from the Slack Platform +* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed +* [slackk auth](slackk_auth.md) - Add and remove local team authorizations +* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators +* [slackk create](slackk_create.md) - Create a new Slack project +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore +* [slackk delete](slackk_delete.md) - Delete the app +* [slackk deploy](slackk_deploy.md) - Deploy the app to the Slack Platform +* [slackk doctor](slackk_doctor.md) - Check and report on system and app information +* [slackk env](slackk_env.md) - Add, remove, or list environment variables +* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers +* [slackk feedback](slackk_feedback.md) - Share feedback about your experience or project +* [slackk function](slackk_function.md) - Manage the functions of an app +* [slackk init](slackk_init.md) - Initialize a project to work with the Slack CLI +* [slackk install](slackk_install.md) - Install the app to a team +* [slackk list](slackk_list.md) - List all authorized accounts +* [slackk login](slackk_login.md) - Log in to a Slack account +* [slackk logout](slackk_logout.md) - Log out of a team +* [slackk manifest](slackk_manifest.md) - Print the app manifest of a project or app +* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform +* [slackk project](slackk_project.md) - Create, manage, and doctor a project +* [slackk run](slackk_run.md) - Start a local server to develop and run the app locally +* [slackk samples](slackk_samples.md) - List available sample apps +* [slackk trigger](slackk_trigger.md) - List details of existing triggers +* [slackk uninstall](slackk_uninstall.md) - Uninstall the app from a team +* [slackk upgrade](slackk_upgrade.md) - Checks for available updates to the CLI or SDK +* [slackk version](slackk_version.md) - Print the version number + diff --git a/docs/reference/commands/slackk_activity.md b/docs/reference/commands/slackk_activity.md new file mode 100644 index 00000000..4ce45505 --- /dev/null +++ b/docs/reference/commands/slackk_activity.md @@ -0,0 +1,60 @@ +## slackk activity + +Display the app activity logs from the Slack Platform + +### Synopsis + +Display the app activity logs from the Slack Platform + +``` +slackk activity [flags] +``` + +### Examples + +``` +$ slackk platform activity # Display app activity logs for an app +$ slackk platform activity -t # Continuously poll for new activity logs +``` + +### Options + +``` + --component string component type to filter + --component-id string component id to filter + (either a function id or workflow id) + --event string event type to filter + -h, --help help for activity + --idle int time to poll without results before exiting + in minutes (default 5) + -i, --interval int polling interval in seconds (default 3) + --level string minimum log level to display (default "info") + (trace, debug, info, warn, error, fatal) + --limit int limit the amount of logs retrieved (default 100) + --max-date-created int maximum timestamp to filter + (unix timestamp in microseconds) + --min-date-created int minimum timestamp to filter + (unix timestamp in microseconds) + --source string source (slack or developer) to filter + -t, --tail continuously poll for new activity + --trace-id string trace id to filter +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_app.md b/docs/reference/commands/slackk_app.md new file mode 100644 index 00000000..ab266ed4 --- /dev/null +++ b/docs/reference/commands/slackk_app.md @@ -0,0 +1,53 @@ +## slackk app + +Install, uninstall, and list teams with the app installed + +### Synopsis + +Install, uninstall, and list teams with the app installed + +``` +slackk app [flags] +``` + +### Examples + +``` +$ slackk app install # Install a production app to a team +$ slackk app link # Link an existing app to the project +$ slackk app list # List all teams with the app installed +$ slackk app settings # Open app settings in a web browser +$ slackk app uninstall # Uninstall an app from a team +$ slackk app delete # Delete an app and app info from a team +``` + +### Options + +``` + -h, --help help for app +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk app delete](slackk_app_delete.md) - Delete the app +* [slackk app install](slackk_app_install.md) - Install the app to a team +* [slackk app link](slackk_app_link.md) - Add an existing app to the project +* [slackk app list](slackk_app_list.md) - List teams with the app installed +* [slackk app settings](slackk_app_settings.md) - Open app settings for configurations +* [slackk app uninstall](slackk_app_uninstall.md) - Uninstall the app from a team + diff --git a/docs/reference/commands/slackk_app_delete.md b/docs/reference/commands/slackk_app_delete.md new file mode 100644 index 00000000..568af13f --- /dev/null +++ b/docs/reference/commands/slackk_app_delete.md @@ -0,0 +1,46 @@ +## slackk app delete + +Delete the app + +### Synopsis + +Uninstall the app from the team and permanently delete the app and all of its data + +``` +slackk app delete [flags] +``` + +### Examples + +``` +# Delete an app and app info from a team +$ slackk app delete + +# Delete a specific app from a team +$ slackk app delete --team T0123456 --app local +``` + +### Options + +``` + -h, --help help for delete +``` + +### 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 + +* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slackk_app_install.md b/docs/reference/commands/slackk_app_install.md new file mode 100644 index 00000000..ced0fbf1 --- /dev/null +++ b/docs/reference/commands/slackk_app_install.md @@ -0,0 +1,52 @@ +## slackk app install + +Install the app to a team + +### Synopsis + +Install the app to a team + +``` +slackk app install [flags] +``` + +### Examples + +``` +# Install a production app to a team +$ slackk app install + +# Install a production app to a specific team +$ slackk app install --team T0123456 --environment deployed + +# Install a local dev app to a specific team +$ slackk app install --team T0123456 --environment local +``` + +### Options + +``` + -E, --environment string environment of app (local, deployed) + -h, --help help for install + --org-workspace-grant string grant access to a specific org workspace ID + (or 'all' for all workspaces in the org) +``` + +### 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 + +* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slackk_app_link.md b/docs/reference/commands/slackk_app_link.md new file mode 100644 index 00000000..d656ffad --- /dev/null +++ b/docs/reference/commands/slackk_app_link.md @@ -0,0 +1,56 @@ +## slackk app link + +Add an existing app to the project + +### Synopsis + +Saves an existing app to a project to be available to other commands. + +The provided App ID and Team ID are stored in the apps.json or apps.dev.json +files in the .slack directory of a project. + +The environment option decides how an app is handled and where information +should be stored. Production apps should be 'deployed' while apps used for +testing and development should be considered 'local'. + +Only one app can exist for each combination of Team ID and environment. + +``` +slackk app link [flags] +``` + +### Examples + +``` +# Add an existing app to a project +$ slackk app link + +# Add a specific app without using prompts +$ slackk app link --team T0123456789 --app A0123456789 --environment deployed +``` + +### Options + +``` + -E, --environment string environment to save existing app (local, deployed) + -h, --help help for link +``` + +### 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 + +* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slackk_app_list.md b/docs/reference/commands/slackk_app_list.md new file mode 100644 index 00000000..749a0143 --- /dev/null +++ b/docs/reference/commands/slackk_app_list.md @@ -0,0 +1,44 @@ +## slackk app list + +List teams with the app installed + +### Synopsis + +List all teams that have installed the app + +``` +slackk app list [flags] +``` + +### Examples + +``` +$ slackk app list # List all teams with the app installed +``` + +### Options + +``` + --all-org-workspace-grants display all workspace grants for an app + installed to an organization + -h, --help help for list +``` + +### 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 + +* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slackk_app_settings.md b/docs/reference/commands/slackk_app_settings.md new file mode 100644 index 00000000..5d2550ba --- /dev/null +++ b/docs/reference/commands/slackk_app_settings.md @@ -0,0 +1,51 @@ +## slackk 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. + +``` +slackk app settings [flags] +``` + +### Examples + +``` +# Open app settings for a prompted app +$ slackk app settings + +# Open app settings for a specific app +$ slackk 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 + +* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slackk_app_uninstall.md b/docs/reference/commands/slackk_app_uninstall.md new file mode 100644 index 00000000..fed586a1 --- /dev/null +++ b/docs/reference/commands/slackk_app_uninstall.md @@ -0,0 +1,42 @@ +## slackk app uninstall + +Uninstall the app from a team + +### Synopsis + +Uninstall the app from a team without deleting the app or its data + +``` +slackk app uninstall [flags] +``` + +### Examples + +``` +$ slackk app uninstall # Uninstall an app from a team +``` + +### Options + +``` + -h, --help help for uninstall +``` + +### 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 + +* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slackk_auth.md b/docs/reference/commands/slackk_auth.md new file mode 100644 index 00000000..5671584b --- /dev/null +++ b/docs/reference/commands/slackk_auth.md @@ -0,0 +1,49 @@ +## slackk auth + +Add and remove local team authorizations + +### Synopsis + +Add and remove local team authorizations + +``` +slackk auth [flags] +``` + +### Examples + +``` +$ slackk auth list # List all authorized accounts +$ slackk auth login # Log in to a Slack account +$ slackk auth logout # Log out of a team +``` + +### Options + +``` + -h, --help help for auth +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk auth list](slackk_auth_list.md) - List all authorized accounts +* [slackk auth login](slackk_auth_login.md) - Log in to a Slack account +* [slackk auth logout](slackk_auth_logout.md) - Log out of a team +* [slackk auth revoke](slackk_auth_revoke.md) - Revoke an authentication token +* [slackk auth token](slackk_auth_token.md) - Collect a service token + diff --git a/docs/reference/commands/slackk_auth_list.md b/docs/reference/commands/slackk_auth_list.md new file mode 100644 index 00000000..1916d947 --- /dev/null +++ b/docs/reference/commands/slackk_auth_list.md @@ -0,0 +1,42 @@ +## slackk auth list + +List all authorized accounts + +### Synopsis + +List all authorized accounts + +``` +slackk auth list [flags] +``` + +### Examples + +``` +$ slackk auth list # List all authorized accounts +``` + +### Options + +``` + -h, --help help for list +``` + +### 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 + +* [slackk auth](slackk_auth.md) - Add and remove local team authorizations + diff --git a/docs/reference/commands/slackk_auth_login.md b/docs/reference/commands/slackk_auth_login.md new file mode 100644 index 00000000..8399e839 --- /dev/null +++ b/docs/reference/commands/slackk_auth_login.md @@ -0,0 +1,55 @@ +## slackk auth login + +Log in to a Slack account + +### Synopsis + +Log in to a Slack account in your team + +``` +slackk auth login [flags] +``` + +### Examples + +``` +# Login to a Slack account with prompts +$ slackk auth login + +# Login to a Slack account without prompts, this returns a ticket +$ slackk auth login --no-prompt + +# Complete login using ticket and challenge code +$ slackk auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... + +# Login with a user token +$ slackk auth login --token xoxp-... +``` + +### Options + +``` + --challenge string provide a challenge code for pre-authenticated login + -h, --help help for login + --no-prompt login without prompts using ticket and challenge code + --ticket string provide an auth ticket value + --token string provide a token for a pre-authenticated login +``` + +### 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 + -v, --verbose print debug logging and additional info +``` + +### SEE ALSO + +* [slackk auth](slackk_auth.md) - Add and remove local team authorizations + diff --git a/docs/reference/commands/slackk_auth_logout.md b/docs/reference/commands/slackk_auth_logout.md new file mode 100644 index 00000000..d8ae6cec --- /dev/null +++ b/docs/reference/commands/slackk_auth_logout.md @@ -0,0 +1,44 @@ +## slackk auth logout + +Log out of a team + +### Synopsis + +Log out of a team, removing any local credentials + +``` +slackk auth logout [flags] +``` + +### Examples + +``` +$ slackk auth logout # Select a team to log out of +$ slackk auth logout --all # Log out of all team +``` + +### Options + +``` + -A, --all logout of all workspaces + -h, --help help for logout +``` + +### 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 + +* [slackk auth](slackk_auth.md) - Add and remove local team authorizations + diff --git a/docs/reference/commands/slackk_auth_revoke.md b/docs/reference/commands/slackk_auth_revoke.md new file mode 100644 index 00000000..a2b7d6cb --- /dev/null +++ b/docs/reference/commands/slackk_auth_revoke.md @@ -0,0 +1,42 @@ +## slackk auth revoke + +Revoke an authentication token + +### Synopsis + +Revoke an authentication token + +``` +slackk auth revoke [flags] +``` + +### Examples + +``` +$ slackk auth revoke --token xoxp-1-4921830... # Revoke a service token +``` + +### Options + +``` + -h, --help help for revoke +``` + +### 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 + +* [slackk auth](slackk_auth.md) - Add and remove local team authorizations + diff --git a/docs/reference/commands/slackk_auth_token.md b/docs/reference/commands/slackk_auth_token.md new file mode 100644 index 00000000..61704a57 --- /dev/null +++ b/docs/reference/commands/slackk_auth_token.md @@ -0,0 +1,52 @@ +## slackk auth token + +Collect a service token + +### Synopsis + +Log in to a Slack account in your team + +``` +slackk auth token [flags] +``` + +### Examples + +``` +# Create a service token with prompts +$ slackk auth token + +# Gather a service token without prompts, this returns a ticket +$ slackk auth token --no-prompt + +# Complete authentication using a ticket and challenge code +$ slackk auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... +``` + +### Options + +``` + --challenge string provide a challenge code for pre-authenticated login + -h, --help help for token + --no-prompt login without prompts using ticket and challenge code + --ticket string provide an auth ticket value +``` + +### 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 + +* [slackk auth](slackk_auth.md) - Add and remove local team authorizations + diff --git a/docs/reference/commands/slackk_collaborator.md b/docs/reference/commands/slackk_collaborator.md new file mode 100644 index 00000000..57192e79 --- /dev/null +++ b/docs/reference/commands/slackk_collaborator.md @@ -0,0 +1,49 @@ +## slackk collaborator + +Manage app collaborators + +### Synopsis + +Manage app collaborators + +``` +slackk collaborator [flags] +``` + +### Examples + +``` +$ slackk collaborator add bots@slack.com # Add a collaborator from email +$ slackk collaborator list # List all of the collaborators + +# Remove a collaborator by user ID +$ slackk collaborator remove USLACKBOT +``` + +### Options + +``` + -h, --help help for collaborator +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk collaborator add](slackk_collaborator_add.md) - Add a new collaborator to the app +* [slackk collaborator list](slackk_collaborator_list.md) - List all collaborators of an app +* [slackk collaborator remove](slackk_collaborator_remove.md) - Remove a collaborator from an app + diff --git a/docs/reference/commands/slackk_collaborator_add.md b/docs/reference/commands/slackk_collaborator_add.md new file mode 100644 index 00000000..66c5f4aa --- /dev/null +++ b/docs/reference/commands/slackk_collaborator_add.md @@ -0,0 +1,44 @@ +## slackk collaborator add + +Add a new collaborator to the app + +### Synopsis + +Add a collaborator to your app by Slack email address or user ID + +``` +slackk collaborator add [email|user_id] [flags] +``` + +### Examples + +``` +$ slackk collaborator add # Add a collaborator via prompt +$ slackk collaborator add bot@slack.com # Add a collaborator from email +$ slackk collaborator add USLACKBOT # Add a collaborator by user ID +``` + +### Options + +``` + -h, --help help for add +``` + +### 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 + +* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators + diff --git a/docs/reference/commands/slackk_collaborator_list.md b/docs/reference/commands/slackk_collaborator_list.md new file mode 100644 index 00000000..bd6ce819 --- /dev/null +++ b/docs/reference/commands/slackk_collaborator_list.md @@ -0,0 +1,42 @@ +## slackk collaborator list + +List all collaborators of an app + +### Synopsis + +List all collaborators of an app + +``` +slackk collaborator list [flags] +``` + +### Examples + +``` +$ slackk collaborator list # List all of the collaborators +``` + +### Options + +``` + -h, --help help for list +``` + +### 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 + +* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators + diff --git a/docs/reference/commands/slackk_collaborator_remove.md b/docs/reference/commands/slackk_collaborator_remove.md new file mode 100644 index 00000000..6167ca17 --- /dev/null +++ b/docs/reference/commands/slackk_collaborator_remove.md @@ -0,0 +1,45 @@ +## slackk collaborator remove + +Remove a collaborator from an app + +### Synopsis + +Remove a collaborator from an app by Slack email address or user ID + +``` +slackk collaborator remove [email|user_id] [flags] +``` + +### Examples + +``` +# Remove collaborator on prompt +$ slackk collaborator remove +$ slackk collaborator remove bot@slack.com # Remove collaborator by email +$ slackk collaborator remove USLACKBOT # Remove collaborator using ID +``` + +### Options + +``` + -h, --help help for remove +``` + +### 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 + +* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators + diff --git a/docs/reference/commands/slackk_create.md b/docs/reference/commands/slackk_create.md new file mode 100644 index 00000000..bf1aaf8c --- /dev/null +++ b/docs/reference/commands/slackk_create.md @@ -0,0 +1,48 @@ +## slackk create + +Create a new Slack project + +### Synopsis + +Create a new Slack project on your local machine from an optional template + +``` +slackk create [name] [flags] +``` + +### Examples + +``` +# Create a new project from a template +$ slackk create my-project + +# Start a new project from a specific template +$ slackk create my-project -t slack-samples/deno-hello-world +``` + +### Options + +``` + -b, --branch string name of git branch to checkout + -h, --help help for create + -t, --template string template URL for your app +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_datastore.md b/docs/reference/commands/slackk_datastore.md new file mode 100644 index 00000000..1b85670b --- /dev/null +++ b/docs/reference/commands/slackk_datastore.md @@ -0,0 +1,81 @@ +## slackk datastore + +Interact with an app's datastore + +### Synopsis + +Interact with the items stored in an app's datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +Discover the datastores: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores"}} + +``` +slackk datastore [flags] +``` + +### Examples + +``` +# Add a new entry to the datastore +$ slackk datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Add two new entries to the datastore +$ slackk datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' + +# Update the entry in the datastore +$ slackk datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Get an item from the datastore +$ slackk datastore get --datastore tasks '{"id": "42"}' + +# Get two items from datastore +$ slackk datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' + +# Remove an item from the datastore +$ slackk datastore delete --datastore tasks '{"id": "42"}' + +# Remove two items from the datastore +$ slackk datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' + +# Query the datastore for specific items +$ slackk datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' + +# Count number of items in datastore +$ slackk datastore count --datastore tasks +``` + +### Options + +``` + -h, --help help for datastore +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk datastore bulk-delete](slackk_datastore_bulk-delete.md) - Delete multiple items from a datastore +* [slackk datastore bulk-get](slackk_datastore_bulk-get.md) - Get multiple items from a datastore +* [slackk datastore bulk-put](slackk_datastore_bulk-put.md) - Create or replace a list of items in a datastore +* [slackk datastore count](slackk_datastore_count.md) - Count the number of items in a datastore +* [slackk datastore delete](slackk_datastore_delete.md) - Delete an item from a datastore +* [slackk datastore get](slackk_datastore_get.md) - Get an item from a datastore +* [slackk datastore put](slackk_datastore_put.md) - Create or replace an item in a datastore +* [slackk datastore query](slackk_datastore_query.md) - Query a datastore for items +* [slackk datastore update](slackk_datastore_update.md) - Create or update an item in a datastore + diff --git a/docs/reference/commands/slackk_datastore_bulk-delete.md b/docs/reference/commands/slackk_datastore_bulk-delete.md new file mode 100644 index 00000000..74c92c7e --- /dev/null +++ b/docs/reference/commands/slackk_datastore_bulk-delete.md @@ -0,0 +1,52 @@ +## slackk datastore bulk-delete + +Delete multiple items from a datastore + +### Synopsis + +Delete multiple items from a datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore bulk-delete [flags] +``` + +### Examples + +``` +# Delete two items from the datastore +$ slackk datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' + +# Delete two items from the datastore with an expression +$ slackk datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for bulk-delete + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_bulk-get.md b/docs/reference/commands/slackk_datastore_bulk-get.md new file mode 100644 index 00000000..9832abc1 --- /dev/null +++ b/docs/reference/commands/slackk_datastore_bulk-get.md @@ -0,0 +1,53 @@ +## slackk datastore bulk-get + +Get multiple items from a datastore + +### Synopsis + +Get multiple items from a datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore bulk-get [flags] +``` + +### Examples + +``` +# Get two items from datastore +$ slackk datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' + +# Get two items from datastore with an expression +$ slackk datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for bulk-get + --output string output format: text, json (default "text") + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_bulk-put.md b/docs/reference/commands/slackk_datastore_bulk-put.md new file mode 100644 index 00000000..5d6e22e3 --- /dev/null +++ b/docs/reference/commands/slackk_datastore_bulk-put.md @@ -0,0 +1,53 @@ +## slackk datastore bulk-put + +Create or replace a list of items in a datastore + +### Synopsis + +Create or replace a list of items in a datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore bulk-put [flags] +``` + +### Examples + +``` +# Create or replace two new entries in the datastore +$ slackk datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' + +# Create or replace two new entries in the datastore with an expression +$ slackk datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' +``` + +### Options + +``` + --datastore string the datastore used to store items + --from-file string store multiple items from a file of JSON Lines + -h, --help help for bulk-put + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_count.md b/docs/reference/commands/slackk_datastore_count.md new file mode 100644 index 00000000..2757b152 --- /dev/null +++ b/docs/reference/commands/slackk_datastore_count.md @@ -0,0 +1,53 @@ +## slackk datastore count + +Count the number of items in a datastore + +### Synopsis + +Count the number of items in a datastore that match a query expression or just +all of the items in the datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore count [expression] [flags] +``` + +### Examples + +``` +# Count all items in a datastore +$ slackk datastore count --datastore tasks + +# Count number of items in datastore that match a query +$ slackk datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for count + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_delete.md b/docs/reference/commands/slackk_datastore_delete.md new file mode 100644 index 00000000..15a9eb8b --- /dev/null +++ b/docs/reference/commands/slackk_datastore_delete.md @@ -0,0 +1,52 @@ +## slackk datastore delete + +Delete an item from a datastore + +### Synopsis + +Delete an item from a datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore delete [flags] +``` + +### Examples + +``` +# Remove an item from the datastore +$ slackk datastore delete --datastore tasks '{"id": "42"}' + +# Remove an item from the datastore with an expression +$ slackk datastore delete '{"datastore": "tasks", "id": "42"}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for delete + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_get.md b/docs/reference/commands/slackk_datastore_get.md new file mode 100644 index 00000000..5da589b9 --- /dev/null +++ b/docs/reference/commands/slackk_datastore_get.md @@ -0,0 +1,53 @@ +## slackk datastore get + +Get an item from a datastore + +### Synopsis + +Get an item from a datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore get [flags] +``` + +### Examples + +``` +# Get an item from the datastore +$ slackk datastore get --datastore tasks '{"id": "42"}' + +# Get an item from the datastore with an expression +$ slackk datastore get '{"datastore": "tasks", "id": "42"}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for get + --output string output format: text, json (default "text") + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_put.md b/docs/reference/commands/slackk_datastore_put.md new file mode 100644 index 00000000..d53ffcbb --- /dev/null +++ b/docs/reference/commands/slackk_datastore_put.md @@ -0,0 +1,52 @@ +## slackk datastore put + +Create or replace an item in a datastore + +### Synopsis + +Create or replace an item in a datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore put [flags] +``` + +### Examples + +``` +# Add a new entry to the datastore +$ slackk datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Add a new entry to the datastore with an expression +$ slackk datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for put + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_query.md b/docs/reference/commands/slackk_datastore_query.md new file mode 100644 index 00000000..5e176ec9 --- /dev/null +++ b/docs/reference/commands/slackk_datastore_query.md @@ -0,0 +1,60 @@ +## slackk datastore query + +Query a datastore for items + +### Synopsis + +Query a datastore for items. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore query [flags] +``` + +### Examples + +``` +# Collect a limited set of items from the datastore +$ slackk datastore query --datastore tasks '{"limit": 8}' --output json + +# Collect items from the datastore starting at a cursor +$ slackk datastore query --datastore tasks '{"cursor": "eyJfX2NWaV..."}' + +# Query the datastore for specific items +$ slackk datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' + +# Query the datastore for specific items with only an expression +$ slackk datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for query + --output string output format: text, json (default "text") + --show only construct a JSON expression + --to-file string save items directly to a file as JSON Lines + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_datastore_update.md b/docs/reference/commands/slackk_datastore_update.md new file mode 100644 index 00000000..26f4fffd --- /dev/null +++ b/docs/reference/commands/slackk_datastore_update.md @@ -0,0 +1,52 @@ +## slackk datastore update + +Create or update an item in a datastore + +### Synopsis + +Create or update an item in a datastore. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk datastore update [flags] +``` + +### Examples + +``` +# Update the entry in the datastore +$ slackk datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Update the entry in the datastore with an expression +$ slackk datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' +``` + +### Options + +``` + --datastore string the datastore used to store items + -h, --help help for update + --show only construct a JSON expression + --unstable kick the tires of experimental features +``` + +### 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 + +* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore + diff --git a/docs/reference/commands/slackk_delete.md b/docs/reference/commands/slackk_delete.md new file mode 100644 index 00000000..f97b0887 --- /dev/null +++ b/docs/reference/commands/slackk_delete.md @@ -0,0 +1,46 @@ +## slackk delete + +Delete the app + +### Synopsis + +Uninstall the app from the team and permanently delete the app and all of its data + +``` +slackk delete [flags] +``` + +### Examples + +``` +# Delete an app and app info from a team +$ slackk app delete + +# Delete a specific app from a team +$ slackk app delete --team T0123456 --app local +``` + +### Options + +``` + -h, --help help for delete +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_deploy.md b/docs/reference/commands/slackk_deploy.md new file mode 100644 index 00000000..475e12dd --- /dev/null +++ b/docs/reference/commands/slackk_deploy.md @@ -0,0 +1,47 @@ +## slackk deploy + +Deploy the app to the Slack Platform + +### Synopsis + +Deploy the app to the Slack Platform + +``` +slackk deploy [flags] +``` + +### Examples + +``` +# Select the workspace to deploy to +$ slackk platform deploy +$ slackk platform deploy --team T0123456 # Deploy to a specific team +``` + +### Options + +``` + -h, --help help for deploy + --hide-triggers do not list triggers and skip trigger creation prompts + --org-workspace-grant string grant access to a specific org workspace ID + (or 'all' for all workspaces in the org) +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_doctor.md b/docs/reference/commands/slackk_doctor.md new file mode 100644 index 00000000..6f6f38a2 --- /dev/null +++ b/docs/reference/commands/slackk_doctor.md @@ -0,0 +1,51 @@ +## slackk doctor + +Check and report on system and app information + +### Synopsis + +Check and report on relevant system (and sometimes app) dependencies + +System dependencies can be reviewed from any directory +* This includes operating system information and Deno and Git versions + +While app dependencies are only shown within a project directory +* This includes the Deno Slack SDK, API, and hooks versions of an app +* New versions will be listed if there are any updates available + +Unfortunately, the doctor command cannot heal all problems + +``` +slackk doctor [flags] +``` + +### Examples + +``` +$ slackk doctor # Create a status report of system dependencies +``` + +### Options + +``` + -h, --help help for doctor +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_env.md b/docs/reference/commands/slackk_env.md new file mode 100644 index 00000000..bca21a87 --- /dev/null +++ b/docs/reference/commands/slackk_env.md @@ -0,0 +1,57 @@ +## slackk env + +Add, remove, or list environment variables + +### Synopsis + +Add, remove, or list environment variables for apps deployed to Slack managed +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: {{LinkText "https://docs.slack.dev/tools/slack-cli/guides/using-environment-variables-with-the-slack-cli"}} + +``` +slackk env [flags] +``` + +### Examples + +``` +$ slackk env add MAGIC_PASSWORD abracadbra # Add an environment variable + +# List all environment variables +$ slackk env list + +# Remove an environment variable +$ slackk env remove MAGIC_PASSWORD +``` + +### Options + +``` + -h, --help help for env +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk env add](slackk_env_add.md) - Add an environment variable to the app +* [slackk env list](slackk_env_list.md) - List all environment variables for the app +* [slackk env remove](slackk_env_remove.md) - Remove an environment variable from the app + diff --git a/docs/reference/commands/slackk_env_add.md b/docs/reference/commands/slackk_env_add.md new file mode 100644 index 00000000..f4250447 --- /dev/null +++ b/docs/reference/commands/slackk_env_add.md @@ -0,0 +1,53 @@ +## slackk env add + +Add an environment variable to the app + +### Synopsis + +Add an environment variable to an app deployed to Slack managed infrastructure. + +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. + +``` +slackk env add [flags] +``` + +### Examples + +``` +# Prompt for an environment variable +$ slackk env add +$ slackk env add MAGIC_PASSWORD abracadbra # Add an environment variable + +# Prompt for an environment variable value +$ slackk env add SECRET_PASSWORD +``` + +### Options + +``` + -h, --help help for add + --value string set the environment variable value +``` + +### 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 + +* [slackk env](slackk_env.md) - Add, remove, or list environment variables + diff --git a/docs/reference/commands/slackk_env_list.md b/docs/reference/commands/slackk_env_list.md new file mode 100644 index 00000000..2208217b --- /dev/null +++ b/docs/reference/commands/slackk_env_list.md @@ -0,0 +1,46 @@ +## slackk env list + +List all environment variables for the app + +### Synopsis + +List all of the environment variables of an app deployed to Slack managed +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. + +``` +slackk env list [flags] +``` + +### Examples + +``` +$ slackk env list # List all environment variables +``` + +### Options + +``` + -h, --help help for list +``` + +### 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 + +* [slackk env](slackk_env.md) - Add, remove, or list environment variables + diff --git a/docs/reference/commands/slackk_env_remove.md b/docs/reference/commands/slackk_env_remove.md new file mode 100644 index 00000000..57363835 --- /dev/null +++ b/docs/reference/commands/slackk_env_remove.md @@ -0,0 +1,51 @@ +## slackk env remove + +Remove an environment variable from the app + +### Synopsis + +Remove an environment variable from an app deployed to Slack managed +infrastructure. + +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. + +``` +slackk env remove [flags] +``` + +### Examples + +``` +# Select an environment variable to remove +$ slackk env remove +$ slackk env remove MAGIC_PASSWORD # Remove an environment variable +``` + +### Options + +``` + -h, --help help for remove + --name string choose the environment variable name +``` + +### 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 + +* [slackk env](slackk_env.md) - Add, remove, or list environment variables + diff --git a/docs/reference/commands/slackk_external-auth.md b/docs/reference/commands/slackk_external-auth.md new file mode 100644 index 00000000..a07d6e5a --- /dev/null +++ b/docs/reference/commands/slackk_external-auth.md @@ -0,0 +1,61 @@ +## slackk external-auth + +Adjust settings of external authentication providers + +### Synopsis + +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: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication"}} + +``` +slackk external-auth [flags] +``` + +### Examples + +``` +# Initiate OAuth2 flow for a selected provider +$ slackk external-auth add + +# Set client secret for an app and provider +$ slackk external-auth add-secret + +# Remove authorization for a specific provider +$ slackk external-auth remove + +# Select authorization for a specific provider in a workflow +$ slackk external-auth select-auth +``` + +### Options + +``` + -h, --help help for external-auth +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk external-auth add](slackk_external-auth_add.md) - Initiate the OAuth2 flow for a provider +* [slackk external-auth add-secret](slackk_external-auth_add-secret.md) - Add the client secret for a provider +* [slackk external-auth remove](slackk_external-auth_remove.md) - Remove the saved tokens for a provider +* [slackk external-auth select-auth](slackk_external-auth_select-auth.md) - Select developer authentication of a workflow + diff --git a/docs/reference/commands/slackk_external-auth_add-secret.md b/docs/reference/commands/slackk_external-auth_add-secret.md new file mode 100644 index 00000000..f16c8467 --- /dev/null +++ b/docs/reference/commands/slackk_external-auth_add-secret.md @@ -0,0 +1,53 @@ +## slackk external-auth add-secret + +Add the client secret for a provider + +### Synopsis + +Add the client secret for an external provider of a workflow app. + +This secret will be used when initiating the OAuth2 flow. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk external-auth add-secret [flags] +``` + +### Examples + +``` +# Input the client secret for an app and provider +$ slackk external-auth add-secret + +# Set the client secret for an app and provider +$ slackk external-auth add-secret -p github -x ghp_token +``` + +### Options + +``` + -h, --help help for add-secret + -p, --provider string the external auth Provider Key to add a secret to + -x, --secret string external auth client secret for the provider +``` + +### 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 + +* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers + diff --git a/docs/reference/commands/slackk_external-auth_add.md b/docs/reference/commands/slackk_external-auth_add.md new file mode 100644 index 00000000..aba4557d --- /dev/null +++ b/docs/reference/commands/slackk_external-auth_add.md @@ -0,0 +1,50 @@ +## slackk external-auth add + +Initiate the OAuth2 flow for a provider + +### Synopsis + +Initiate the OAuth2 flow for an external auth provider 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. + +``` +slackk external-auth add [flags] +``` + +### Examples + +``` +# Select a provider to initiate the OAuth2 flow for +$ slackk external-auth add + +# Initiate the OAuth2 flow for the provided provider +$ slackk external-auth add -p github +``` + +### Options + +``` + -h, --help help for add + -p, --provider string the external auth Provider Key to add a secret to +``` + +### 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 + +* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers + diff --git a/docs/reference/commands/slackk_external-auth_remove.md b/docs/reference/commands/slackk_external-auth_remove.md new file mode 100644 index 00000000..398036c2 --- /dev/null +++ b/docs/reference/commands/slackk_external-auth_remove.md @@ -0,0 +1,60 @@ +## slackk external-auth remove + +Remove the saved tokens for a provider + +### Synopsis + +Remove tokens saved to external authentication providers of a workflow app. + +Existing tokens are only removed from your app, but are not revoked or deleted! +Tokens must be invalidated using the provider's developer console or via APIs. + +This command is supported for apps deployed to Slack managed infrastructure but +other apps can attempt to run the command with the --force flag. + +``` +slackk external-auth remove [flags] +``` + +### Examples + +``` +# Remove a token from the selected provider +$ slackk external-auth remove + +# Remove a token from the specified provider +$ slackk external-auth remove -p github + +# Remove all tokens from the specified provider +$ slackk external-auth remove --all -p github + +# Remove all tokens from all providers +$ slackk external-auth remove --all +``` + +### Options + +``` + -A, --all remove tokens for all providers or the specified provider + -h, --help help for remove + -p, --provider string the external auth Provider Key to remove a token for +``` + +### 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 + +* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers + diff --git a/docs/reference/commands/slackk_external-auth_select-auth.md b/docs/reference/commands/slackk_external-auth_select-auth.md new file mode 100644 index 00000000..d5d348c0 --- /dev/null +++ b/docs/reference/commands/slackk_external-auth_select-auth.md @@ -0,0 +1,50 @@ +## slackk external-auth select-auth + +Select developer authentication of a workflow + +### Synopsis + +Select the saved developer authentication to use when calling external APIs from +functions in 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. + +``` +slackk external-auth select-auth [flags] +``` + +### Examples + +``` +# Select the saved developer authentication in a workflow +$ slackk external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com +``` + +### Options + +``` + -E, --external-account string external account identifier for the provider + -h, --help help for select-auth + -p, --provider string provider of the developer account + -W, --workflow string workflow to set developer authentication for +``` + +### 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 + +* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers + diff --git a/docs/reference/commands/slackk_feedback.md b/docs/reference/commands/slackk_feedback.md new file mode 100644 index 00000000..9a388ac1 --- /dev/null +++ b/docs/reference/commands/slackk_feedback.md @@ -0,0 +1,49 @@ +## slackk feedback + +Share feedback about your experience or project + +### Synopsis + +Help us make the Slack Platform better with your feedback + +``` +slackk feedback [flags] +``` + +### Examples + +``` +# Choose to give feedback on part of the Slack Platform +$ slackk feedback +$ slackk feedback --name slack-cli # Give feedback on the Slack CLI +``` + +### Options + +``` + -h, --help help for feedback + --name string name of the feedback: + slack-cli + slack-platform + + --no-prompt run command without prompts +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_function.md b/docs/reference/commands/slackk_function.md new file mode 100644 index 00000000..e9be7361 --- /dev/null +++ b/docs/reference/commands/slackk_function.md @@ -0,0 +1,56 @@ +## slackk function + +Manage the functions of an app + +### Synopsis + +Functions are pieces of logic that complete the puzzle of workflows in Workflow +Builder. Whatever that puzzle might be. + +Inspect and configure the custom functions included in an app with this command. +Functions can be added as a step in Workflow Builder and shared among teammates. + +Learn more about functions: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions"}} + +``` +slackk function [flags] +``` + +### Examples + +``` +# Select a function and choose distribution options +$ slackk function distribute + +# Distribute a function to everyone in a workspace +$ slackk function distribute --name callback_id --everyone + +# Lookup the distribution information for a function +$ slackk function distribute --info +``` + +### Options + +``` + -h, --help help for function +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk function access](slackk_function_access.md) - Adjust who can access functions published from an app + diff --git a/docs/reference/commands/slackk_function_access.md b/docs/reference/commands/slackk_function_access.md new file mode 100644 index 00000000..277aef9e --- /dev/null +++ b/docs/reference/commands/slackk_function_access.md @@ -0,0 +1,70 @@ +## slackk function access + +Adjust who can access functions published from an app + +### Synopsis + +Adjust who can {{ToBold "access"}} functions published by an app when building a workflow in +Workflow Builder. + +New functions are granted access to {{ToBold "app collaborators"}} by default. This includes +both the {{ToBold "reader"}} and {{ToBold "owner"}} permissions. Access can also be {{ToBold "granted"}} or {{ToBold "revoked"}} to +specific {{ToBold "users"}} or {{ToBold "everyone"}} alongside the {{ToBold "app collaborators"}}. + +Workflows that include a function with limited access can still be invoked with +a trigger of the workflow. The {{ToBold "access"}} command applies to Workflow Builder access +only. + +``` +slackk function access [flags] +``` + +### Examples + +``` +# Select a function and choose access options +$ slackk function access + +# Share a function with everyone in a workspace +$ slackk function access --name callback_id --everyone + +# Revoke function access for multiple users +$ slackk function access --name callback_id --revoke \ + --users USLACKBOT,U012345678,U0RHJTSPQ3 + +# Lookup access information for a function +$ slackk function access --info +``` + +### Options + +``` + -A, --app-collaborators grant access to only fellow app collaborators + -E, --everyone grant access to everyone in installed workspaces + -F, --file string specify access permissions using a file + -G, --grant grant access to --users to use --name + -h, --help help for access + -I, --info check who has access to the function --name + -N, --name string the callback_id of a function in your app + -R, --revoke revoke access for --users to use --name + -U, --users string a comma-separated list of Slack user IDs +``` + +### 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 + +* [slackk function](slackk_function.md) - Manage the functions of an app + diff --git a/docs/reference/commands/slackk_init.md b/docs/reference/commands/slackk_init.md new file mode 100644 index 00000000..7124377b --- /dev/null +++ b/docs/reference/commands/slackk_init.md @@ -0,0 +1,62 @@ +## slackk init + +Initialize a project to work with the Slack CLI + +### Synopsis + +Initializes a project to support the Slack CLI. + +Adds a .slack directory with the following files: +- project-name/.slack +- project-name/.slack/.gitignore +- project-name/.slack/config.json +- project-name/.slack/hooks.json + +Adds the Slack CLI hooks dependency to your project: +- Deno: Unsupported +- Node.js: Updates package.json +- Python: Updates requirements.txt + +Installs your project dependencies when supported: +- Deno: Supported +- Node.js: Supported +- Python: Unsupported + +Adds an existing app to your project (optional): +- Prompts to add an existing app from app settings +- Runs the command `slackk app link` + +``` +slackk init [flags] +``` + +### Examples + +``` +$ slackk init # Initialize a project +``` + +### Options + +``` + -h, --help help for init +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_install.md b/docs/reference/commands/slackk_install.md new file mode 100644 index 00000000..656dfba7 --- /dev/null +++ b/docs/reference/commands/slackk_install.md @@ -0,0 +1,52 @@ +## slackk install + +Install the app to a team + +### Synopsis + +Install the app to a team + +``` +slackk install [flags] +``` + +### Examples + +``` +# Install a production app to a team +$ slackk app install + +# Install a production app to a specific team +$ slackk app install --team T0123456 --environment deployed + +# Install a local dev app to a specific team +$ slackk app install --team T0123456 --environment local +``` + +### Options + +``` + -E, --environment string environment of app (local, deployed) + -h, --help help for install + --org-workspace-grant string grant access to a specific org workspace ID + (or 'all' for all workspaces in the org) +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_list.md b/docs/reference/commands/slackk_list.md new file mode 100644 index 00000000..3f6d8a1a --- /dev/null +++ b/docs/reference/commands/slackk_list.md @@ -0,0 +1,42 @@ +## slackk list + +List all authorized accounts + +### Synopsis + +List all authorized accounts + +``` +slackk list [flags] +``` + +### Examples + +``` +$ slackk auth list # List all authorized accounts +``` + +### Options + +``` + -h, --help help for list +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_login.md b/docs/reference/commands/slackk_login.md new file mode 100644 index 00000000..dc917414 --- /dev/null +++ b/docs/reference/commands/slackk_login.md @@ -0,0 +1,55 @@ +## slackk login + +Log in to a Slack account + +### Synopsis + +Log in to a Slack account in your team + +``` +slackk login [flags] +``` + +### Examples + +``` +# Login to a Slack account with prompts +$ slackk auth login + +# Login to a Slack account without prompts, this returns a ticket +$ slackk auth login --no-prompt + +# Complete login using ticket and challenge code +$ slackk auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... + +# Login with a user token +$ slackk auth login --token xoxp-... +``` + +### Options + +``` + --challenge string provide a challenge code for pre-authenticated login + -h, --help help for login + --no-prompt login without prompts using ticket and challenge code + --ticket string provide an auth ticket value + --token string provide a token for a pre-authenticated login +``` + +### 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 + -v, --verbose print debug logging and additional info +``` + +### SEE ALSO + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_logout.md b/docs/reference/commands/slackk_logout.md new file mode 100644 index 00000000..46ed3c88 --- /dev/null +++ b/docs/reference/commands/slackk_logout.md @@ -0,0 +1,44 @@ +## slackk logout + +Log out of a team + +### Synopsis + +Log out of a team, removing any local credentials + +``` +slackk logout [flags] +``` + +### Examples + +``` +$ slackk auth logout # Select a team to log out of +$ slackk auth logout --all # Log out of all team +``` + +### Options + +``` + -A, --all logout of all workspaces + -h, --help help for logout +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_manifest.md b/docs/reference/commands/slackk_manifest.md new file mode 100644 index 00000000..3d890afe --- /dev/null +++ b/docs/reference/commands/slackk_manifest.md @@ -0,0 +1,56 @@ +## slackk manifest + +Print the app manifest of a project or app + +### Synopsis + +Get the manifest of an app using either the "remote" values on app settings +or from the "local" configurations. + +Subcommands unlock additional engagements and interactions with the manifest. + +The manifest on app settings represents the latest version of the manifest. + +Project configurations use the "get-manifest" hook from ".slack/hooks.json". + +``` +slackk manifest [flags] +``` + +### Examples + +``` +# Display the app manifest for the current project +$ slackk manifest info + +# Validate the app manifest generated by a project +$ slackk manifest validate +``` + +### Options + +``` + -h, --help help for manifest + --source string source of the app manifest ("local" or "remote") +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk manifest info](slackk_manifest_info.md) - Print the app manifest of a project or app +* [slackk manifest validate](slackk_manifest_validate.md) - Validate the app manifest generated by a project + diff --git a/docs/reference/commands/slackk_manifest_info.md b/docs/reference/commands/slackk_manifest_info.md new file mode 100644 index 00000000..a1c2abfb --- /dev/null +++ b/docs/reference/commands/slackk_manifest_info.md @@ -0,0 +1,55 @@ +## slackk manifest info + +Print the app manifest of a project or app + +### Synopsis + +Get the manifest of an app using either the "remote" values on app settings +or from the "local" configurations. + +The manifest on app settings represents the latest version of the manifest. + +Project configurations use the "get-manifest" hook from ".slack/hooks.json". + +``` +slackk manifest info [flags] +``` + +### Examples + +``` +# Print the app manifest from project configurations +$ slackk manifest info + +# Print the remote manifest of an app +$ slackk manifest info --app A0123456789 + +# Print the app manifest gathered from App Config +$ slackk manifest info --source remote +``` + +### Options + +``` + -h, --help help for info + --source string source of the app manifest ("local" or "remote") +``` + +### 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 + +* [slackk manifest](slackk_manifest.md) - Print the app manifest of a project or app + diff --git a/docs/reference/commands/slackk_manifest_validate.md b/docs/reference/commands/slackk_manifest_validate.md new file mode 100644 index 00000000..51ce34a8 --- /dev/null +++ b/docs/reference/commands/slackk_manifest_validate.md @@ -0,0 +1,43 @@ +## slackk manifest validate + +Validate the app manifest generated by a project + +### Synopsis + +Validate the app manifest generated from a valid project directory + +``` +slackk manifest validate [flags] +``` + +### Examples + +``` +# Validate the app manifest generated by a project +$ slackk manifest validate +``` + +### Options + +``` + -h, --help help for validate +``` + +### 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 + +* [slackk manifest](slackk_manifest.md) - Print the app manifest of a project or app + diff --git a/docs/reference/commands/slackk_platform.md b/docs/reference/commands/slackk_platform.md new file mode 100644 index 00000000..1897dab1 --- /dev/null +++ b/docs/reference/commands/slackk_platform.md @@ -0,0 +1,47 @@ +## slackk platform + +Deploy and run apps on the Slack Platform + +### Synopsis + +Deploy and run apps on the Slack Platform + +``` +slackk platform [flags] +``` + +### Examples + +``` +$ slackk run # Run an app locally in a workspace +$ slackk deploy --team T0123456 # Deploy to a specific team +$ slackk activity -t # Continuously poll for new activity logs +``` + +### Options + +``` + -h, --help help for platform +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk platform activity](slackk_platform_activity.md) - Display the app activity logs from the Slack Platform +* [slackk platform deploy](slackk_platform_deploy.md) - Deploy the app to the Slack Platform +* [slackk platform run](slackk_platform_run.md) - Start a local server to develop and run the app locally + diff --git a/docs/reference/commands/slackk_platform_activity.md b/docs/reference/commands/slackk_platform_activity.md new file mode 100644 index 00000000..ba04ffad --- /dev/null +++ b/docs/reference/commands/slackk_platform_activity.md @@ -0,0 +1,60 @@ +## slackk platform activity + +Display the app activity logs from the Slack Platform + +### Synopsis + +Display the app activity logs from the Slack Platform + +``` +slackk platform activity [flags] +``` + +### Examples + +``` +$ slackk platform activity # Display app activity logs for an app +$ slackk platform activity -t # Continuously poll for new activity logs +``` + +### Options + +``` + --component string component type to filter + --component-id string component id to filter + (either a function id or workflow id) + --event string event type to filter + -h, --help help for activity + --idle int time to poll without results before exiting + in minutes (default 5) + -i, --interval int polling interval in seconds (default 3) + --level string minimum log level to display (default "info") + (trace, debug, info, warn, error, fatal) + --limit int limit the amount of logs retrieved (default 100) + --max-date-created int maximum timestamp to filter + (unix timestamp in microseconds) + --min-date-created int minimum timestamp to filter + (unix timestamp in microseconds) + --source string source (slack or developer) to filter + -t, --tail continuously poll for new activity + --trace-id string trace id to filter +``` + +### 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 + +* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform + diff --git a/docs/reference/commands/slackk_platform_deploy.md b/docs/reference/commands/slackk_platform_deploy.md new file mode 100644 index 00000000..34fdf572 --- /dev/null +++ b/docs/reference/commands/slackk_platform_deploy.md @@ -0,0 +1,47 @@ +## slackk platform deploy + +Deploy the app to the Slack Platform + +### Synopsis + +Deploy the app to the Slack Platform + +``` +slackk platform deploy [flags] +``` + +### Examples + +``` +# Select the workspace to deploy to +$ slackk platform deploy +$ slackk platform deploy --team T0123456 # Deploy to a specific team +``` + +### Options + +``` + -h, --help help for deploy + --hide-triggers do not list triggers and skip trigger creation prompts + --org-workspace-grant string grant access to a specific org workspace ID + (or 'all' for all workspaces in the org) +``` + +### 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 + +* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform + diff --git a/docs/reference/commands/slackk_platform_run.md b/docs/reference/commands/slackk_platform_run.md new file mode 100644 index 00000000..ab3b3551 --- /dev/null +++ b/docs/reference/commands/slackk_platform_run.md @@ -0,0 +1,55 @@ +## slackk platform run + +Start a local server to develop and run the app locally + +### Synopsis + +Start a local server to develop and run the app locally while watching for file changes + +``` +slackk platform run [flags] +``` + +### Examples + +``` +# Start a local development server +$ slackk platform run + +# Run a local development server with debug activity +$ slackk platform run --activity-level debug + +# Run a local development server with cleanup +$ slackk platform run --cleanup +``` + +### Options + +``` + --activity-level string activity level to display (default "info") + --cleanup uninstall the local app after exiting + -h, --help help for run + --hide-triggers do not list triggers and skip trigger creation prompts + --no-activity hide Slack Platform log activity + --org-workspace-grant string grant access to a specific org workspace ID + (or 'all' for all workspaces in the org) +``` + +### 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 + +* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform + diff --git a/docs/reference/commands/slackk_project.md b/docs/reference/commands/slackk_project.md new file mode 100644 index 00000000..ab3d6150 --- /dev/null +++ b/docs/reference/commands/slackk_project.md @@ -0,0 +1,58 @@ +## slackk project + +Create, manage, and doctor a project + +### Synopsis + +Create, manage, and doctor a project and its configuration files. + +Get started by creating a new project using the {{ToBold "create"}} command. + +Initialize an existing project with CLI support using the {{ToBold "init"}} command. + +Check your project health and diagnose problems with the {{ToBold "doctor"}} command. + +``` +slackk project [flags] +``` + +### Examples + +``` +# Creates a new Slack project from an optional template +$ slackk project create + +# Initialize an existing project to work with the Slack CLI +$ slackk project init + +# Creates a new Slack project from the sample gallery +$ slackk project samples +``` + +### Options + +``` + -h, --help help for project +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk project create](slackk_project_create.md) - Create a new Slack project +* [slackk project init](slackk_project_init.md) - Initialize a project to work with the Slack CLI +* [slackk project samples](slackk_project_samples.md) - List available sample apps + diff --git a/docs/reference/commands/slackk_project_create.md b/docs/reference/commands/slackk_project_create.md new file mode 100644 index 00000000..454f59a6 --- /dev/null +++ b/docs/reference/commands/slackk_project_create.md @@ -0,0 +1,48 @@ +## slackk project create + +Create a new Slack project + +### Synopsis + +Create a new Slack project on your local machine from an optional template + +``` +slackk project create [name] [flags] +``` + +### Examples + +``` +# Create a new project from a template +$ slackk create my-project + +# Start a new project from a specific template +$ slackk create my-project -t slack-samples/deno-hello-world +``` + +### Options + +``` + -b, --branch string name of git branch to checkout + -h, --help help for create + -t, --template string template URL for your app +``` + +### 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 + +* [slackk project](slackk_project.md) - Create, manage, and doctor a project + diff --git a/docs/reference/commands/slackk_project_init.md b/docs/reference/commands/slackk_project_init.md new file mode 100644 index 00000000..302731c0 --- /dev/null +++ b/docs/reference/commands/slackk_project_init.md @@ -0,0 +1,62 @@ +## slackk project init + +Initialize a project to work with the Slack CLI + +### Synopsis + +Initializes a project to support the Slack CLI. + +Adds a .slack directory with the following files: +- project-name/.slack +- project-name/.slack/.gitignore +- project-name/.slack/config.json +- project-name/.slack/hooks.json + +Adds the Slack CLI hooks dependency to your project: +- Deno: Unsupported +- Node.js: Updates package.json +- Python: Updates requirements.txt + +Installs your project dependencies when supported: +- Deno: Supported +- Node.js: Supported +- Python: Unsupported + +Adds an existing app to your project (optional): +- Prompts to add an existing app from app settings +- Runs the command `slackk app link` + +``` +slackk project init [flags] +``` + +### Examples + +``` +$ slackk init # Initialize a project +``` + +### Options + +``` + -h, --help help for init +``` + +### 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 + +* [slackk project](slackk_project.md) - Create, manage, and doctor a project + diff --git a/docs/reference/commands/slackk_project_samples.md b/docs/reference/commands/slackk_project_samples.md new file mode 100644 index 00000000..ce965883 --- /dev/null +++ b/docs/reference/commands/slackk_project_samples.md @@ -0,0 +1,46 @@ +## slackk project samples + +List available sample apps + +### Synopsis + +List and create an app from the available samples + +``` +slackk project samples [name] [flags] +``` + +### Examples + +``` +$ slackk samples my-project # Select a sample app to create +``` + +### Options + +``` + -b, --branch string name of git branch to checkout + -h, --help help for samples + --language string runtime for the app framework + ex: "deno", "node", "python" + -t, --template string template URL for your app +``` + +### 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 + +* [slackk project](slackk_project.md) - Create, manage, and doctor a project + diff --git a/docs/reference/commands/slackk_run.md b/docs/reference/commands/slackk_run.md new file mode 100644 index 00000000..d323e80f --- /dev/null +++ b/docs/reference/commands/slackk_run.md @@ -0,0 +1,55 @@ +## slackk run + +Start a local server to develop and run the app locally + +### Synopsis + +Start a local server to develop and run the app locally while watching for file changes + +``` +slackk run [flags] +``` + +### Examples + +``` +# Start a local development server +$ slackk platform run + +# Run a local development server with debug activity +$ slackk platform run --activity-level debug + +# Run a local development server with cleanup +$ slackk platform run --cleanup +``` + +### Options + +``` + --activity-level string activity level to display (default "info") + --cleanup uninstall the local app after exiting + -h, --help help for run + --hide-triggers do not list triggers and skip trigger creation prompts + --no-activity hide Slack Platform log activity + --org-workspace-grant string grant access to a specific org workspace ID + (or 'all' for all workspaces in the org) +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_samples.md b/docs/reference/commands/slackk_samples.md new file mode 100644 index 00000000..682c100b --- /dev/null +++ b/docs/reference/commands/slackk_samples.md @@ -0,0 +1,46 @@ +## slackk samples + +List available sample apps + +### Synopsis + +List and create an app from the available samples + +``` +slackk samples [name] [flags] +``` + +### Examples + +``` +$ slackk samples my-project # Select a sample app to create +``` + +### Options + +``` + -b, --branch string name of git branch to checkout + -h, --help help for samples + --language string runtime for the app framework + ex: "deno", "node", "python" + -t, --template string template URL for your app +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_trigger.md b/docs/reference/commands/slackk_trigger.md new file mode 100644 index 00000000..fb0e1c2d --- /dev/null +++ b/docs/reference/commands/slackk_trigger.md @@ -0,0 +1,62 @@ +## slackk trigger + +List details of existing triggers + +### Synopsis + +List details of existing triggers + +``` +slackk trigger [flags] +``` + +### Examples + +``` +# Select who can run a trigger +$ slackk trigger access +$ slackk trigger create # Create a new trigger + +# Delete an existing trigger +$ slackk trigger delete --trigger-id Ft01234ABCD + +# Get details for a trigger +$ slackk trigger info --trigger-id Ft01234ABCD + +# List details for all existing triggers +$ slackk trigger list + +# Update a trigger definition +$ slackk trigger update --trigger-id Ft01234ABCD +``` + +### Options + +``` + -h, --help help for trigger +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool +* [slackk trigger access](slackk_trigger_access.md) - Manage who can use your triggers +* [slackk trigger create](slackk_trigger_create.md) - Create a trigger for a workflow +* [slackk trigger delete](slackk_trigger_delete.md) - Delete an existing trigger +* [slackk trigger info](slackk_trigger_info.md) - Get details for a specific trigger +* [slackk trigger list](slackk_trigger_list.md) - List details of existing triggers +* [slackk trigger update](slackk_trigger_update.md) - Updates an existing trigger + diff --git a/docs/reference/commands/slackk_trigger_access.md b/docs/reference/commands/slackk_trigger_access.md new file mode 100644 index 00000000..4927236c --- /dev/null +++ b/docs/reference/commands/slackk_trigger_access.md @@ -0,0 +1,65 @@ +## slackk trigger access + +Manage who can use your triggers + +### Synopsis + +Manage who can use your triggers + +``` +slackk trigger access --trigger-id [flags] +``` + +### Examples + +``` +# Grant everyone access to run a trigger +$ slackk trigger access --trigger-id Ft01234ABCD --everyone + +# Grant certain channels access to run a trigger +$ slackk trigger access --trigger-id Ft01234ABCD --grant \ + --channels C012345678 + +# Revoke certain users access to run a trigger +$ slackk trigger access --trigger-id Ft01234ABCD --revoke \ + --users USLACKBOT,U012345678 +``` + +### Options + +``` + -A, --app-collaborators grant permission to only app collaborators + -C, --channels string a comma-separated list of Slack channel IDs + -E, --everyone grant permission to everyone in your workspace + -G, --grant grant permission to --users or --channels to + run the trigger --trigger-id + -h, --help help for access + --include-app-collaborators include app collaborators into named + entities to run the trigger --trigger-id + -I, --info check who has access to the trigger --trigger-id + -O, --organizations string a comma-separated list of Slack organization IDs + -R, --revoke revoke permission for --users or --channels to + run the trigger --trigger-id + -T, --trigger-id string the ID of the trigger + -U, --users string a comma-separated list of Slack user IDs + -W, --workspaces string a comma-separated list of Slack workspace IDs +``` + +### 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 + +* [slackk trigger](slackk_trigger.md) - List details of existing triggers + diff --git a/docs/reference/commands/slackk_trigger_create.md b/docs/reference/commands/slackk_trigger_create.md new file mode 100644 index 00000000..c422d188 --- /dev/null +++ b/docs/reference/commands/slackk_trigger_create.md @@ -0,0 +1,67 @@ +## slackk trigger create + +Create a trigger for a workflow + +### Synopsis + +Create a trigger to start a workflow + +``` +slackk trigger create [flags] +``` + +### Examples + +``` +# Create a trigger by selecting an app and trigger definition +$ slackk trigger create + +# Create a trigger from a definition file +$ slackk trigger create --trigger-def "triggers/shortcut_trigger.ts" + +# Create a trigger for a workflow +$ slackk trigger create --workflow "#/workflows/my_workflow" +``` + +### Options + +``` + --description string the description of this trigger + -h, --help help for create + --interactivity when used with --workflow, adds a + "slack#/types/interactivity" parameter + to the trigger with the name specified + by --interactivity-name + --interactivity-name string when used with --interactivity, specifies + the name of the interactivity parameter + to use (default "interactivity") + --org-workspace-grant string grant access to a specific org workspace ID + (or 'all' for all workspaces in the org) + --title string the title of this trigger + (default "My Trigger") + --trigger-def string path to a JSON file containing the trigger + definition. Overrides other flags setting + trigger properties. + --workflow string a reference to the workflow to execute + formatted as: + "#/workflows/" +``` + +### 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 + +* [slackk trigger](slackk_trigger.md) - List details of existing triggers + diff --git a/docs/reference/commands/slackk_trigger_delete.md b/docs/reference/commands/slackk_trigger_delete.md new file mode 100644 index 00000000..20990ecc --- /dev/null +++ b/docs/reference/commands/slackk_trigger_delete.md @@ -0,0 +1,47 @@ +## slackk trigger delete + +Delete an existing trigger + +### Synopsis + +Delete an existing trigger + +``` +slackk trigger delete --trigger-id [flags] +``` + +### Examples + +``` +# Delete a specific trigger in a selected workspace +$ slackk trigger delete --trigger-id Ft01234ABCD + +# Delete a specific trigger for an app +$ slackk trigger delete --trigger-id Ft01234ABCD --app A0123456 +``` + +### Options + +``` + -h, --help help for delete + --trigger-id string the ID of the trigger +``` + +### 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 + +* [slackk trigger](slackk_trigger.md) - List details of existing triggers + diff --git a/docs/reference/commands/slackk_trigger_info.md b/docs/reference/commands/slackk_trigger_info.md new file mode 100644 index 00000000..c8a4cee3 --- /dev/null +++ b/docs/reference/commands/slackk_trigger_info.md @@ -0,0 +1,47 @@ +## slackk trigger info + +Get details for a specific trigger + +### Synopsis + +Get details for a specific trigger + +``` +slackk trigger info --trigger-id [flags] +``` + +### Examples + +``` +# Get details for a specific trigger in a selected workspace +$ slackk trigger info --trigger-id Ft01234ABCD + +# Get details for a specific trigger +$ slackk trigger info --trigger-id Ft01234ABCD --app A0123456 +``` + +### Options + +``` + -h, --help help for info + --trigger-id string the ID of the trigger +``` + +### 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 + +* [slackk trigger](slackk_trigger.md) - List details of existing triggers + diff --git a/docs/reference/commands/slackk_trigger_list.md b/docs/reference/commands/slackk_trigger_list.md new file mode 100644 index 00000000..8335a50b --- /dev/null +++ b/docs/reference/commands/slackk_trigger_list.md @@ -0,0 +1,48 @@ +## slackk trigger list + +List details of existing triggers + +### Synopsis + +List details of existing triggers + +``` +slackk trigger list [flags] +``` + +### Examples + +``` +# List details for all existing triggers +$ slackk trigger list + +# List triggers for a specific app +$ slackk trigger list --team T0123456 --app local +``` + +### Options + +``` + -h, --help help for list + -L, --limit int Limit the number of triggers to show (default 4) + -T, --type string Only display triggers of the given type, can be one of 'all', 'shortcut', 'event', 'scheduled', 'webhook', and 'external' (default "all") +``` + +### 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 + +* [slackk trigger](slackk_trigger.md) - List details of existing triggers + diff --git a/docs/reference/commands/slackk_trigger_update.md b/docs/reference/commands/slackk_trigger_update.md new file mode 100644 index 00000000..2bdeb2cf --- /dev/null +++ b/docs/reference/commands/slackk_trigger_update.md @@ -0,0 +1,64 @@ +## slackk trigger update + +Updates an existing trigger + +### Synopsis + +Updates an existing trigger with the provided definition. Only supports full replacement, no partial update. + +``` +slackk trigger update --trigger-id [flags] +``` + +### Examples + +``` +# Update a trigger definition with a selected file +$ slackk trigger update --trigger-id Ft01234ABCD + +# Update a trigger with a workflow id and title +$ slackk trigger update --trigger-id Ft01234ABCD \ + --workflow "#/workflows/my_workflow" --title "Updated trigger" +``` + +### Options + +``` + --description string the description of this trigger + -h, --help help for update + --interactivity when used with --workflow, adds a + "slack#/types/interactivity" parameter + to the trigger with the name specified + by --interactivity-name + --interactivity-name string when used with --interactivity, specifies + the name of the interactivity parameter + to use (default "interactivity") + --title string the title of this trigger + (default "My Trigger") + --trigger-def string path to a JSON file containing the trigger + definition. Overrides other flags setting + trigger properties. + --trigger-id string the ID of the trigger to update + --workflow string a reference to the workflow to execute + formatted as: + "#/workflows/" +``` + +### 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 + +* [slackk trigger](slackk_trigger.md) - List details of existing triggers + diff --git a/docs/reference/commands/slackk_uninstall.md b/docs/reference/commands/slackk_uninstall.md new file mode 100644 index 00000000..e73f77cd --- /dev/null +++ b/docs/reference/commands/slackk_uninstall.md @@ -0,0 +1,42 @@ +## slackk uninstall + +Uninstall the app from a team + +### Synopsis + +Uninstall the app from a team without deleting the app or its data + +``` +slackk uninstall [flags] +``` + +### Examples + +``` +$ slackk app uninstall # Uninstall an app from a team +``` + +### Options + +``` + -h, --help help for uninstall +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_upgrade.md b/docs/reference/commands/slackk_upgrade.md new file mode 100644 index 00000000..787d3fc4 --- /dev/null +++ b/docs/reference/commands/slackk_upgrade.md @@ -0,0 +1,46 @@ +## slackk upgrade + +Checks for available updates to the CLI or SDK + +### Synopsis + +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 {{LinkText "https://docs.slack.dev/changelog"}} + +``` +slackk upgrade [flags] +``` + +### Examples + +``` +$ slackk upgrade # Check for any available updates +``` + +### Options + +``` + -h, --help help for upgrade +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/commands/slackk_version.md b/docs/reference/commands/slackk_version.md new file mode 100644 index 00000000..d84bcd7e --- /dev/null +++ b/docs/reference/commands/slackk_version.md @@ -0,0 +1,64 @@ +## slackk version + +Print the version number + +### Synopsis + +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` + +``` +slackk version [flags] +``` + +### Examples + +``` +$ slackk version # Print version number using the command +$ slackk --version # Print version number using the flag +$ slackk --version --skip-update # Print version and skip update check +``` + +### Options + +``` + -h, --help help for version +``` + +### 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 + +* [slackk](slackk.md) - Slack command-line tool + diff --git a/docs/reference/errors.md b/docs/reference/errors.md index bdf735b6..6c6714b8 100644 --- a/docs/reference/errors.md +++ b/docs/reference/errors.md @@ -101,9 +101,9 @@ and some ways to remediate them. https://docs.slack.dev/tools/deno-slack-sdk -If you are using a Bolt framework, add a deploy hook then run: `slack deploy` +If you are using a Bolt framework, add a deploy hook then run: `slackk deploy` -Otherwise start your app for local development with: `slack run` +Otherwise start your app for local development with: `slackk run` --- @@ -123,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 --- @@ -226,7 +226,7 @@ Read about ROSI: https://docs.slack.dev/workflows/run-on-slack-infrastructure **Message**: Couldn't find a valid auth token for the Slack API -**Remediation**: You need to be logged in to at least 1 production (slack.com) team to use this command. Log into one with the `slack login` command and try again. +**Remediation**: You need to be logged in to at least 1 production (slack.com) team to use this command. Log into one with the `slackk login` command and try again. --- @@ -361,7 +361,7 @@ Move the .slack/cli.json file to .slack/hooks.json and try again. **Message**: Slack API requires the latest version of the Slack CLI -**Remediation**: You can upgrade to the latest version of the Slack CLI using the command: `slack upgrade` +**Remediation**: You can upgrade to the latest version of the Slack CLI using the command: `slackk upgrade` --- @@ -426,7 +426,7 @@ Approval is pending review **Message**: No authentication found for this team -**Remediation**: Use the command `slack login` to login to this workspace +**Remediation**: Use the command `slackk login` to login to this workspace --- @@ -558,7 +558,7 @@ Approval is pending review **Message**: The name of the feedback is invalid -**Remediation**: View the feedback options with `slack feedback --help` +**Remediation**: View the feedback options with `slackk feedback --help` --- @@ -566,8 +566,8 @@ Approval is pending review **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` +**Remediation**: Please provide a `--name ` flag or remove the `--no-prompt` flag +View feedback options with `slackk feedback --help` --- @@ -681,7 +681,7 @@ View feedback options with `slack feedback --help` **Message**: A valid installation of this app is required to take this action -**Remediation**: Install the app with `slack install` +**Remediation**: Install the app with `slackk install` --- @@ -705,7 +705,7 @@ View feedback options with `slack feedback --help` **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` +If this is a Slack project, you can initialize it with `slackk init` --- @@ -714,7 +714,7 @@ If this is a Slack project, you can initialize it with `slack init` **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 --- @@ -748,7 +748,7 @@ Or choose a specific app with `--app ` **Message**: Your user account authorization isn't valid -**Remediation**: Your user account authorization may be expired or does not have permission to access the resource. Try to login to the same user account again using `slack login`. +**Remediation**: Your user account authorization may be expired or does not have permission to access the resource. Try to login to the same user account again using `slackk login`. --- @@ -756,7 +756,7 @@ Or choose a specific app with `--app ` **Message**: The challenge code is invalid -**Remediation**: The previous slash command and challenge code have now expired. To retry, use `slack login`, paste the slash command in any Slack channel, and enter the challenge code displayed by Slack. It is easiest to copy & paste the challenge code. +**Remediation**: The previous slash command and challenge code have now expired. To retry, use `slackk login`, paste the slash command in any Slack channel, and enter the challenge code displayed by Slack. It is easiest to copy & paste the challenge code. --- @@ -785,7 +785,7 @@ Or choose a specific app with `--app ` **Message**: The provided expression is not valid **Remediation**: Verify the expression you provided is valid JSON surrounded by quotations -Use `slack datastore --help` for examples +Use `slackk datastore --help` for examples --- @@ -818,7 +818,7 @@ Use `slack datastore --help` for examples **Message**: A manifest does not exist at the provided source **Remediation**: Set 'manifest.source' to either "remote" or "local" in .slack/config.json -Read about manifest sourcing with the `slack manifest info --help` command +Read about manifest sourcing with the `slackk manifest info --help` command --- @@ -1052,7 +1052,7 @@ Read about manifest sourcing with the `slack manifest info --help` command **Message**: Your login is out of date -**Remediation**: Run `slack logout` and then `slack login` again. +**Remediation**: Run `slackk logout` and then `slackk login` again. --- @@ -1118,7 +1118,7 @@ Read about manifest sourcing with the `slack manifest info --help` command **Message**: You are either not logged in or your login session has expired -**Remediation**: Authorize your CLI with `slack login` +**Remediation**: Authorize your CLI with `slackk login` --- @@ -1193,7 +1193,7 @@ Read about manifest sourcing with the `slack manifest info --help` command **Message**: Project manifest source is not valid **Remediation**: Set 'manifest.source' to either "remote" or "local" in .slack/config.json -Read about manifest sourcing with the `slack manifest info --help` command +Read about manifest sourcing with the `slackk manifest info --help` command --- @@ -1239,9 +1239,17 @@ Read about manifest sourcing with the `slack manifest info --help` command --- +### runtime_not_found {#runtime_not_found} + +**Message**: The hook runtime executable was not found + +**Remediation**: Make sure the required runtime has been installed to run hook scripts. + +--- + ### runtime_not_supported {#runtime_not_supported} -**Message**: The SDK language's executable (deno, node, python, etc) was not found to be installed on the system +**Message**: The SDK runtime is not supported by the CLI --- @@ -1261,15 +1269,7 @@ Read about manifest sourcing with the `slack manifest info --help` command **Message**: There was an error while reading the Slack hooks file (`.slack/hooks.json`) or running the `get-hooks` hook -**Remediation**: Run `slack doctor` to check that your system dependencies are up-to-date. - ---- - -### sdk_hook_get_trigger_not_found {#sdk_hook_get_trigger_not_found} - -**Message**: The `get-trigger` hook script in `.slack/hooks.json` was not found - -**Remediation**: Try defining your trigger by specifying a json file instead. +**Remediation**: Run `slackk doctor` to check that your system dependencies are up-to-date. --- @@ -1277,7 +1277,7 @@ Read about manifest sourcing with the `slack manifest info --help` command **Message**: A script hook defined in the Slack Configuration file (`.slack/hooks.json`) returned an error -**Remediation**: Run `slack doctor` to check that your system dependencies are up-to-date. +**Remediation**: Run `slackk doctor` to check that your system dependencies are up-to-date. --- @@ -1290,9 +1290,9 @@ Read about manifest sourcing with the `slack manifest info --help` command - .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. +You can create a hooks file manually or with the `slackk init` command. When manually creating the hooks file, you must install the hook dependencies. @@ -1314,7 +1314,7 @@ When manually creating the hooks file, you must install the hook dependencies. **Message**: You are not logged into a team or have not installed an app -**Remediation**: Use the command `slack login` to login and `slack install` to install your app +**Remediation**: Use the command `slackk login` to login and `slackk install` to install your app --- @@ -1376,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 --- @@ -1420,7 +1420,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: Your access token has expired -**Remediation**: Use the command `slack login` to authenticate again +**Remediation**: Use the command `slackk login` to authenticate again --- @@ -1428,7 +1428,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: Your token has already been revoked -**Remediation**: Use the command `slack login` to authenticate again +**Remediation**: Use the command `slackk login` to authenticate again --- @@ -1436,7 +1436,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: An error occurred while rotating your access token -**Remediation**: Use the command `slack login` to authenticate again +**Remediation**: Use the command `slackk login` to authenticate again --- From 5639941c328a9c1a5c4f1a516bf6626d54536531 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Fri, 15 Aug 2025 12:56:00 -0700 Subject: [PATCH 2/4] build run --- .../workflows/slack-cli-generate-docs.yaml | 2 +- docs/reference/commands/slack.md | 28 ++++----- docs/reference/commands/slack_activity.md | 22 +++---- docs/reference/commands/slack_app.md | 30 ++++----- docs/reference/commands/slack_app_delete.md | 28 ++++----- docs/reference/commands/slack_app_install.md | 31 ++++++---- docs/reference/commands/slack_app_link.md | 28 ++++----- docs/reference/commands/slack_app_list.md | 20 +++--- docs/reference/commands/slack_app_settings.md | 28 ++++----- .../reference/commands/slack_app_uninstall.md | 20 +++--- docs/reference/commands/slack_auth.md | 24 +++---- docs/reference/commands/slack_auth_list.md | 20 +++--- docs/reference/commands/slack_auth_login.md | 40 ++++++------ docs/reference/commands/slack_auth_logout.md | 22 +++---- docs/reference/commands/slack_auth_revoke.md | 20 +++--- docs/reference/commands/slack_auth_token.md | 34 +++++----- docs/reference/commands/slack_collaborator.md | 28 ++++----- .../commands/slack_collaborator_add.md | 24 +++---- .../commands/slack_collaborator_list.md | 20 +++--- .../commands/slack_collaborator_remove.md | 24 +++---- docs/reference/commands/slack_create.md | 28 ++++----- docs/reference/commands/slack_datastore.md | 46 +++++++------- .../commands/slack_datastore_bulk-delete.md | 28 ++++----- .../commands/slack_datastore_bulk-get.md | 28 ++++----- .../commands/slack_datastore_bulk-put.md | 28 ++++----- .../commands/slack_datastore_count.md | 28 ++++----- .../commands/slack_datastore_delete.md | 28 ++++----- .../reference/commands/slack_datastore_get.md | 28 ++++----- .../reference/commands/slack_datastore_put.md | 28 ++++----- .../commands/slack_datastore_query.md | 40 ++++++------ .../commands/slack_datastore_update.md | 28 ++++----- docs/reference/commands/slack_delete.md | 28 ++++----- docs/reference/commands/slack_deploy.md | 24 +++---- docs/reference/commands/slack_doctor.md | 20 +++--- docs/reference/commands/slack_env.md | 34 +++++----- docs/reference/commands/slack_env_add.md | 30 ++++----- docs/reference/commands/slack_env_list.md | 20 +++--- docs/reference/commands/slack_env_remove.md | 24 +++---- .../reference/commands/slack_external-auth.md | 42 ++++++------- .../slack_external-auth_add-secret.md | 28 ++++----- .../commands/slack_external-auth_add.md | 28 ++++----- .../commands/slack_external-auth_remove.md | 40 ++++++------ .../slack_external-auth_select-auth.md | 22 +++---- docs/reference/commands/slack_feedback.md | 24 +++---- docs/reference/commands/slack_function.md | 36 +++++------ .../commands/slack_function_access.md | 42 ++++++------- docs/reference/commands/slack_init.md | 20 +++--- docs/reference/commands/slack_install.md | 31 ++++++---- docs/reference/commands/slack_list.md | 20 +++--- docs/reference/commands/slack_login.md | 40 ++++++------ docs/reference/commands/slack_logout.md | 22 +++---- docs/reference/commands/slack_manifest.md | 28 ++++----- .../reference/commands/slack_manifest_info.md | 34 +++++----- .../commands/slack_manifest_validate.md | 22 +++---- docs/reference/commands/slack_platform.md | 24 +++---- .../commands/slack_platform_activity.md | 22 +++---- .../commands/slack_platform_deploy.md | 24 +++---- docs/reference/commands/slack_platform_run.md | 34 +++++----- docs/reference/commands/slack_project.md | 34 +++++----- .../commands/slack_project_create.md | 28 ++++----- docs/reference/commands/slack_project_init.md | 20 +++--- .../commands/slack_project_samples.md | 24 +++---- docs/reference/commands/slack_run.md | 34 +++++----- docs/reference/commands/slack_samples.md | 24 +++---- docs/reference/commands/slack_trigger.md | 44 ++++++------- .../commands/slack_trigger_access.md | 38 ++++++------ .../commands/slack_trigger_create.md | 34 +++++----- .../commands/slack_trigger_delete.md | 28 ++++----- docs/reference/commands/slack_trigger_info.md | 28 ++++----- docs/reference/commands/slack_trigger_list.md | 28 ++++----- .../commands/slack_trigger_update.md | 30 ++++----- docs/reference/commands/slack_uninstall.md | 20 +++--- docs/reference/commands/slack_upgrade.md | 20 +++--- docs/reference/commands/slack_version.md | 24 +++---- docs/reference/errors.md | 62 ++++++++++--------- 75 files changed, 1067 insertions(+), 1047 deletions(-) diff --git a/.github/workflows/slack-cli-generate-docs.yaml b/.github/workflows/slack-cli-generate-docs.yaml index 75fcaa88..61b8e7eb 100644 --- a/.github/workflows/slack-cli-generate-docs.yaml +++ b/.github/workflows/slack-cli-generate-docs.yaml @@ -26,7 +26,7 @@ jobs: - name: Generate docs run: | - slack docgen content/slack-cli/reference + slack docgen docs/reference - name: Create a pull request uses: peter-evans/create-pull-request@v7 diff --git a/docs/reference/commands/slack.md b/docs/reference/commands/slack.md index 1ecaee8d..ca9e5dd4 100644 --- a/docs/reference/commands/slack.md +++ b/docs/reference/commands/slack.md @@ -2,27 +2,17 @@ Slack command-line tool -## Synopsis +## Description CLI to create, run, and deploy Slack apps -Get started by reading the docs: [https://docs.slack.dev/tools/slack-cli](https://docs.slack.dev/tools/slack-cli/) +Get started by reading the docs: [https://docs.slack.dev/tools/slack-cli](https://docs.slack.dev/tools/slack-cli) ``` slack [flags] ``` -## Examples - -``` -$ slack login # Log in to your Slack account -$ 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 -``` - -## Options +## Flags ``` -a, --app string use a specific app ID or environment @@ -37,7 +27,17 @@ $ slack deploy # Deploy to the Slack Platform -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack login # Log in to your Slack account +$ 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 +``` + +## See also * [slack activity](slack_activity) - Display the app activity logs from the Slack Platform * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_activity.md b/docs/reference/commands/slack_activity.md index b46104f5..397fec27 100644 --- a/docs/reference/commands/slack_activity.md +++ b/docs/reference/commands/slack_activity.md @@ -2,7 +2,7 @@ Display the app activity logs from the Slack Platform -## Synopsis +## Description Display the app activity logs from the Slack Platform @@ -10,14 +10,7 @@ Display the app activity logs from the Slack Platform slack activity [flags] ``` -## Examples - -``` -$ slack platform activity # Display app activity logs for an app -$ slack platform activity -t # Continuously poll for new activity logs -``` - -## Options +## Flags ``` --component string component type to filter @@ -40,7 +33,7 @@ $ slack platform activity -t # Continuously poll for new activity logs --trace-id string trace id to filter ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -54,7 +47,14 @@ $ slack platform activity -t # Continuously poll for new activity logs -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack platform activity # Display app activity logs for an app +$ slack platform activity -t # Continuously poll for new activity logs +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_app.md b/docs/reference/commands/slack_app.md index 1083f672..be817fa5 100644 --- a/docs/reference/commands/slack_app.md +++ b/docs/reference/commands/slack_app.md @@ -2,7 +2,7 @@ Install, uninstall, and list teams with the app installed -## Synopsis +## Description Install, uninstall, and list teams with the app installed @@ -10,24 +10,13 @@ Install, uninstall, and list teams with the app installed slack app [flags] ``` -## Examples - -``` -$ 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 +## Flags ``` -h, --help help for app ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -41,7 +30,18 @@ $ slack app delete # Delete an app and app info from a team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ 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 +``` + +## See also * [slack](slack) - Slack command-line tool * [slack app delete](slack_app_delete) - Delete the app diff --git a/docs/reference/commands/slack_app_delete.md b/docs/reference/commands/slack_app_delete.md index 1cc5986a..31336532 100644 --- a/docs/reference/commands/slack_app_delete.md +++ b/docs/reference/commands/slack_app_delete.md @@ -2,7 +2,7 @@ Delete the app -## Synopsis +## Description Uninstall the app from the team and permanently delete the app and all of its data @@ -10,23 +10,13 @@ Uninstall the app from the team and permanently delete the app and all of its da slack app delete [flags] ``` -## Examples - -``` -# Delete an app and app info from a team -$ slack app delete - -# Delete a specific app from a team -$ slack app delete --team T0123456 --app local -``` - -## Options +## Flags ``` -h, --help help for delete ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -40,7 +30,17 @@ $ slack app delete --team T0123456 --app local -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Delete an app and app info from a team +$ slack app delete + +# Delete a specific app from a team +$ slack app delete --team T0123456 --app local +``` + +## See also * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_install.md b/docs/reference/commands/slack_app_install.md index e8d27536..d8c7dbfc 100644 --- a/docs/reference/commands/slack_app_install.md +++ b/docs/reference/commands/slack_app_install.md @@ -2,7 +2,7 @@ Install the app to a team -## Synopsis +## Description Install the app to a team @@ -10,24 +10,16 @@ Install the app to a team slack app install [flags] ``` -## Examples - -``` -$ slack app install # Install a production app to a team - -# Install a production app to a specific team -$ slack app install --team T0123456 -``` - -## Options +## Flags ``` + -E, --environment string environment of app (local, deployed) -h, --help help for install --org-workspace-grant string grant access to a specific org workspace ID (or 'all' for all workspaces in the org) ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -41,7 +33,20 @@ $ slack app install --team T0123456 -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Install a production app to a team +$ slack app install + +# Install a production app to a specific team +$ slack app install --team T0123456 --environment deployed + +# Install a local dev app to a specific team +$ slack app install --team T0123456 --environment local +``` + +## See also * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_link.md b/docs/reference/commands/slack_app_link.md index 848059c4..0afc1b20 100644 --- a/docs/reference/commands/slack_app_link.md +++ b/docs/reference/commands/slack_app_link.md @@ -2,7 +2,7 @@ Add an existing app to the project -## Synopsis +## Description Saves an existing app to a project to be available to other commands. @@ -19,24 +19,14 @@ Only one app can exist for each combination of Team ID and environment. slack app link [flags] ``` -## Examples - -``` -# Add an existing app to a project -$ slack app link - -# Add a specific app without using prompts -$ slack app link --team T0123456789 --app A0123456789 --environment deployed -``` - -## Options +## Flags ``` -E, --environment string environment to save existing app (local, deployed) -h, --help help for link ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -50,7 +40,17 @@ $ slack app link --team T0123456789 --app A0123456789 --environment deployed -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Add an existing app to a project +$ slack app link + +# Add a specific app without using prompts +$ slack app link --team T0123456789 --app A0123456789 --environment deployed +``` + +## See also * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_list.md b/docs/reference/commands/slack_app_list.md index 452d4ab2..d38b8f81 100644 --- a/docs/reference/commands/slack_app_list.md +++ b/docs/reference/commands/slack_app_list.md @@ -2,7 +2,7 @@ List teams with the app installed -## Synopsis +## Description List all teams that have installed the app @@ -10,13 +10,7 @@ List all teams that have installed the app slack app list [flags] ``` -## Examples - -``` -$ slack app list # List all teams with the app installed -``` - -## Options +## Flags ``` --all-org-workspace-grants display all workspace grants for an app @@ -24,7 +18,7 @@ $ slack app list # List all teams with the app installed -h, --help help for list ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +32,13 @@ $ slack app list # List all teams with the app installed -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack app list # List all teams with the app installed +``` + +## See also * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_settings.md b/docs/reference/commands/slack_app_settings.md index 58895fab..7c2c5325 100644 --- a/docs/reference/commands/slack_app_settings.md +++ b/docs/reference/commands/slack_app_settings.md @@ -2,7 +2,7 @@ Open app settings for configurations -## Synopsis +## Description Open app settings to configure an application in a web browser. @@ -15,23 +15,13 @@ 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 +## Flags ``` -h, --help help for settings ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -45,7 +35,17 @@ $ slack app settings --app A0123456789 -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Open app settings for a prompted app +$ slack app settings + +# Open app settings for a specific app +$ slack app settings --app A0123456789 +``` + +## See also * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_uninstall.md b/docs/reference/commands/slack_app_uninstall.md index dea27a0d..4977663d 100644 --- a/docs/reference/commands/slack_app_uninstall.md +++ b/docs/reference/commands/slack_app_uninstall.md @@ -2,7 +2,7 @@ Uninstall the app from a team -## Synopsis +## Description Uninstall the app from a team without deleting the app or its data @@ -10,19 +10,13 @@ Uninstall the app from a team without deleting the app or its data slack app uninstall [flags] ``` -## Examples - -``` -$ slack app uninstall # Uninstall an app from a team -``` - -## Options +## Flags ``` -h, --help help for uninstall ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -36,7 +30,13 @@ $ slack app uninstall # Uninstall an app from a team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack app uninstall # Uninstall an app from a team +``` + +## See also * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_auth.md b/docs/reference/commands/slack_auth.md index 112c9fef..6f91b6ed 100644 --- a/docs/reference/commands/slack_auth.md +++ b/docs/reference/commands/slack_auth.md @@ -2,7 +2,7 @@ Add and remove local team authorizations -## Synopsis +## Description Add and remove local team authorizations @@ -10,21 +10,13 @@ Add and remove local team authorizations slack auth [flags] ``` -## Examples - -``` -$ slack auth list # List all authorized accounts -$ slack auth login # Log in to a Slack account -$ slack auth logout # Log out of a team -``` - -## Options +## Flags ``` -h, --help help for auth ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +30,15 @@ $ slack auth logout # Log out of a team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack auth list # List all authorized accounts +$ slack auth login # Log in to a Slack account +$ slack auth logout # Log out of a team +``` + +## See also * [slack](slack) - Slack command-line tool * [slack auth list](slack_auth_list) - List all authorized accounts diff --git a/docs/reference/commands/slack_auth_list.md b/docs/reference/commands/slack_auth_list.md index 42f18c02..01837506 100644 --- a/docs/reference/commands/slack_auth_list.md +++ b/docs/reference/commands/slack_auth_list.md @@ -2,7 +2,7 @@ List all authorized accounts -## Synopsis +## Description List all authorized accounts @@ -10,19 +10,13 @@ List all authorized accounts slack auth list [flags] ``` -## Examples - -``` -$ slack auth list # List all authorized accounts -``` - -## Options +## Flags ``` -h, --help help for list ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -36,7 +30,13 @@ $ slack auth list # List all authorized accounts -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack auth list # List all authorized accounts +``` + +## See also * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_login.md b/docs/reference/commands/slack_auth_login.md index cfe277ce..b12fac2c 100644 --- a/docs/reference/commands/slack_auth_login.md +++ b/docs/reference/commands/slack_auth_login.md @@ -2,7 +2,7 @@ Log in to a Slack account -## Synopsis +## Description Log in to a Slack account in your team @@ -10,23 +10,7 @@ Log in to a Slack account in your team slack auth login [flags] ``` -## Examples - -``` -# Login to a Slack account with prompts -$ slack auth login - -# Login to a Slack account without prompts, this returns a ticket -$ slack auth login --no-prompt - -# Complete login using ticket and challenge code -$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... - -# Login with a user token -$ slack auth login --token xoxp-... -``` - -## Options +## Flags ``` --challenge string provide a challenge code for pre-authenticated login @@ -36,7 +20,7 @@ $ slack auth login --token xoxp-... --token string provide a token for a pre-authenticated login ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -49,7 +33,23 @@ $ slack auth login --token xoxp-... -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Login to a Slack account with prompts +$ slack auth login + +# Login to a Slack account without prompts, this returns a ticket +$ slack auth login --no-prompt + +# Complete login using ticket and challenge code +$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... + +# Login with a user token +$ slack auth login --token xoxp-... +``` + +## See also * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_logout.md b/docs/reference/commands/slack_auth_logout.md index c266d9a8..92fa7292 100644 --- a/docs/reference/commands/slack_auth_logout.md +++ b/docs/reference/commands/slack_auth_logout.md @@ -2,7 +2,7 @@ Log out of a team -## Synopsis +## Description Log out of a team, removing any local credentials @@ -10,21 +10,14 @@ Log out of a team, removing any local credentials slack auth logout [flags] ``` -## Examples - -``` -$ slack auth logout # Select a team to log out of -$ slack auth logout --all # Log out of all team -``` - -## Options +## Flags ``` -A, --all logout of all workspaces -h, --help help for logout ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +31,14 @@ $ slack auth logout --all # Log out of all team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack auth logout # Select a team to log out of +$ slack auth logout --all # Log out of all team +``` + +## See also * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_revoke.md b/docs/reference/commands/slack_auth_revoke.md index 5e630c0f..efb228ae 100644 --- a/docs/reference/commands/slack_auth_revoke.md +++ b/docs/reference/commands/slack_auth_revoke.md @@ -2,7 +2,7 @@ Revoke an authentication token -## Synopsis +## Description Revoke an authentication token @@ -10,19 +10,13 @@ Revoke an authentication token slack auth revoke [flags] ``` -## Examples - -``` -$ slack auth revoke --token xoxp-1-4921830... # Revoke a service token -``` - -## Options +## Flags ``` -h, --help help for revoke ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -36,7 +30,13 @@ $ slack auth revoke --token xoxp-1-4921830... # Revoke a service token -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack auth revoke --token xoxp-1-4921830... # Revoke a service token +``` + +## See also * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_token.md b/docs/reference/commands/slack_auth_token.md index ed4c00eb..32002814 100644 --- a/docs/reference/commands/slack_auth_token.md +++ b/docs/reference/commands/slack_auth_token.md @@ -2,7 +2,7 @@ Collect a service token -## Synopsis +## Description Log in to a Slack account in your team @@ -10,20 +10,7 @@ Log in to a Slack account in your team slack auth token [flags] ``` -## Examples - -``` -# Create a service token with prompts -$ slack auth token - -# Gather a service token without prompts, this returns a ticket -$ slack auth token --no-prompt - -# Complete authentication using a ticket and challenge code -$ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... -``` - -## Options +## Flags ``` --challenge string provide a challenge code for pre-authenticated login @@ -32,7 +19,7 @@ $ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... --ticket string provide an auth ticket value ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -46,7 +33,20 @@ $ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Create a service token with prompts +$ slack auth token + +# Gather a service token without prompts, this returns a ticket +$ slack auth token --no-prompt + +# Complete authentication using a ticket and challenge code +$ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... +``` + +## See also * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_collaborator.md b/docs/reference/commands/slack_collaborator.md index d7059428..47428061 100644 --- a/docs/reference/commands/slack_collaborator.md +++ b/docs/reference/commands/slack_collaborator.md @@ -2,7 +2,7 @@ Manage app collaborators -## Synopsis +## Description Manage app collaborators @@ -10,23 +10,13 @@ Manage app collaborators slack collaborator [flags] ``` -## Examples - -``` -$ slack collaborator add bots@slack.com # Add a collaborator from email -$ slack collaborator list # List all of the collaborators - -# Remove a collaborator by user ID -$ slack collaborator remove USLACKBOT -``` - -## Options +## Flags ``` -h, --help help for collaborator ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -40,7 +30,17 @@ $ slack collaborator remove USLACKBOT -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack collaborator add bots@slack.com # Add a collaborator from email +$ slack collaborator list # List all of the collaborators + +# Remove a collaborator by user ID +$ slack collaborator remove USLACKBOT +``` + +## See also * [slack](slack) - Slack command-line tool * [slack collaborator add](slack_collaborator_add) - Add a new collaborator to the app diff --git a/docs/reference/commands/slack_collaborator_add.md b/docs/reference/commands/slack_collaborator_add.md index b175ac0b..82e4e6c1 100644 --- a/docs/reference/commands/slack_collaborator_add.md +++ b/docs/reference/commands/slack_collaborator_add.md @@ -2,7 +2,7 @@ Add a new collaborator to the app -## Synopsis +## Description Add a collaborator to your app by Slack email address or user ID @@ -10,21 +10,13 @@ Add a collaborator to your app by Slack email address or user ID slack collaborator add [email|user_id] [flags] ``` -## Examples - -``` -$ slack collaborator add # Add a collaborator via prompt -$ slack collaborator add bot@slack.com # Add a collaborator from email -$ slack collaborator add USLACKBOT # Add a collaborator by user ID -``` - -## Options +## Flags ``` -h, --help help for add ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +30,15 @@ $ slack collaborator add USLACKBOT # Add a collaborator by user ID -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack collaborator add # Add a collaborator via prompt +$ slack collaborator add bot@slack.com # Add a collaborator from email +$ slack collaborator add USLACKBOT # Add a collaborator by user ID +``` + +## See also * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_collaborator_list.md b/docs/reference/commands/slack_collaborator_list.md index d1282beb..283607be 100644 --- a/docs/reference/commands/slack_collaborator_list.md +++ b/docs/reference/commands/slack_collaborator_list.md @@ -2,7 +2,7 @@ List all collaborators of an app -## Synopsis +## Description List all collaborators of an app @@ -10,19 +10,13 @@ List all collaborators of an app slack collaborator list [flags] ``` -## Examples - -``` -$ slack collaborator list # List all of the collaborators -``` - -## Options +## Flags ``` -h, --help help for list ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -36,7 +30,13 @@ $ slack collaborator list # List all of the collaborators -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack collaborator list # List all of the collaborators +``` + +## See also * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_collaborator_remove.md b/docs/reference/commands/slack_collaborator_remove.md index 7aeeea9a..676daa4e 100644 --- a/docs/reference/commands/slack_collaborator_remove.md +++ b/docs/reference/commands/slack_collaborator_remove.md @@ -2,7 +2,7 @@ Remove a collaborator from an app -## Synopsis +## Description Remove a collaborator from an app by Slack email address or user ID @@ -10,21 +10,13 @@ Remove a collaborator from an app by Slack email address or user ID slack collaborator remove [email|user_id] [flags] ``` -## Examples - -``` -$ slack collaborator remove # Remove collaborator on prompt -$ slack collaborator remove bot@slack.com # Remove collaborator by email -$ slack collaborator remove USLACKBOT # Remove collaborator using ID -``` - -## Options +## Flags ``` -h, --help help for remove ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +30,15 @@ $ slack collaborator remove USLACKBOT # Remove collaborator using ID -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack collaborator remove # Remove collaborator on prompt +$ slack collaborator remove bot@slack.com # Remove collaborator by email +$ slack collaborator remove USLACKBOT # Remove collaborator using ID +``` + +## See also * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_create.md b/docs/reference/commands/slack_create.md index a8b1add5..f11205a0 100644 --- a/docs/reference/commands/slack_create.md +++ b/docs/reference/commands/slack_create.md @@ -2,7 +2,7 @@ Create a new Slack project -## Synopsis +## Description Create a new Slack project on your local machine from an optional template @@ -10,17 +10,7 @@ Create a new Slack project on your local machine from an optional template slack create [name] [flags] ``` -## Examples - -``` -# Create a new project from a template -$ slack create my-project - -# Start a new project from a specific template -$ slack create my-project -t slack-samples/deno-hello-world -``` - -## Options +## Flags ``` -b, --branch string name of git branch to checkout @@ -28,7 +18,7 @@ $ slack create my-project -t slack-samples/deno-hello-world -t, --template string template URL for your app ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -42,7 +32,17 @@ $ slack create my-project -t slack-samples/deno-hello-world -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Create a new project from a template +$ slack create my-project + +# Start a new project from a specific template +$ slack create my-project -t slack-samples/deno-hello-world +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_datastore.md b/docs/reference/commands/slack_datastore.md index 02c6bc19..da6f1ae4 100644 --- a/docs/reference/commands/slack_datastore.md +++ b/docs/reference/commands/slack_datastore.md @@ -2,19 +2,39 @@ Interact with an app's datastore -## Synopsis +## Description Interact with the items stored in an app's datastore. This command is supported for apps deployed to Slack managed infrastructure but other apps can attempt to run the command with the --force flag. -Discover the datastores: [https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores](https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores/) +Discover the datastores: [https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores](https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores) ``` slack datastore [flags] ``` +## Flags + +``` + -h, --help help for datastore +``` + +## 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 ``` @@ -46,27 +66,7 @@ $ slack datastore query --datastore tasks '{"expression": "#status = :status", " $ slack datastore count --datastore tasks ``` -## Options - -``` - -h, --help help for datastore -``` - -## 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 +## See also * [slack](slack) - Slack command-line tool * [slack datastore bulk-delete](slack_datastore_bulk-delete) - Delete multiple items from a datastore diff --git a/docs/reference/commands/slack_datastore_bulk-delete.md b/docs/reference/commands/slack_datastore_bulk-delete.md index b8c6bde5..b7dc6d92 100644 --- a/docs/reference/commands/slack_datastore_bulk-delete.md +++ b/docs/reference/commands/slack_datastore_bulk-delete.md @@ -2,7 +2,7 @@ Delete multiple items from a datastore -## Synopsis +## Description Delete multiple items from a datastore. @@ -13,17 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-delete [flags] ``` -## Examples - -``` -# Delete two items from the datastore -$ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' - -# Delete two items from the datastore with an expression -$ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -32,7 +22,7 @@ $ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -46,7 +36,17 @@ $ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Delete two items from the datastore +$ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' + +# Delete two items from the datastore with an expression +$ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_bulk-get.md b/docs/reference/commands/slack_datastore_bulk-get.md index f6406341..1aee8c55 100644 --- a/docs/reference/commands/slack_datastore_bulk-get.md +++ b/docs/reference/commands/slack_datastore_bulk-get.md @@ -2,7 +2,7 @@ Get multiple items from a datastore -## Synopsis +## Description Get multiple items from a datastore. @@ -13,17 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-get [flags] ``` -## Examples - -``` -# Get two items from datastore -$ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' - -# Get two items from datastore with an expression -$ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -33,7 +23,7 @@ $ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -47,7 +37,17 @@ $ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Get two items from datastore +$ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' + +# Get two items from datastore with an expression +$ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_bulk-put.md b/docs/reference/commands/slack_datastore_bulk-put.md index 3c857609..da6bb7f4 100644 --- a/docs/reference/commands/slack_datastore_bulk-put.md +++ b/docs/reference/commands/slack_datastore_bulk-put.md @@ -2,7 +2,7 @@ Create or replace a list of items in a datastore -## Synopsis +## Description Create or replace a list of items in a datastore. @@ -13,17 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-put [flags] ``` -## Examples - -``` -# Create or replace two new entries in the datastore -$ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' - -# Create or replace two new entries in the datastore with an expression -$ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -33,7 +23,7 @@ $ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "descr --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -47,7 +37,17 @@ $ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "descr -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Create or replace two new entries in the datastore +$ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' + +# Create or replace two new entries in the datastore with an expression +$ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_count.md b/docs/reference/commands/slack_datastore_count.md index f2528300..4ed1e473 100644 --- a/docs/reference/commands/slack_datastore_count.md +++ b/docs/reference/commands/slack_datastore_count.md @@ -2,7 +2,7 @@ Count the number of items in a datastore -## Synopsis +## Description Count the number of items in a datastore that match a query expression or just all of the items in the datastore. @@ -14,17 +14,7 @@ other apps can attempt to run the command with the --force flag. slack datastore count [expression] [flags] ``` -## Examples - -``` -# Count all items in a datastore -$ slack datastore count --datastore tasks - -# Count number of items in datastore that match a query -$ slack datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -33,7 +23,7 @@ $ slack datastore count '{"datastore": "tasks", "expression": "#status = :status --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -47,7 +37,17 @@ $ slack datastore count '{"datastore": "tasks", "expression": "#status = :status -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Count all items in a datastore +$ slack datastore count --datastore tasks + +# Count number of items in datastore that match a query +$ slack datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_delete.md b/docs/reference/commands/slack_datastore_delete.md index 34a66e0d..1eb684cf 100644 --- a/docs/reference/commands/slack_datastore_delete.md +++ b/docs/reference/commands/slack_datastore_delete.md @@ -2,7 +2,7 @@ Delete an item from a datastore -## Synopsis +## Description Delete an item from a datastore. @@ -13,17 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore delete [flags] ``` -## Examples - -``` -# Remove an item from the datastore -$ slack datastore delete --datastore tasks '{"id": "42"}' - -# Remove an item from the datastore with an expression -$ slack datastore delete '{"datastore": "tasks", "id": "42"}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -32,7 +22,7 @@ $ slack datastore delete '{"datastore": "tasks", "id": "42"}' --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -46,7 +36,17 @@ $ slack datastore delete '{"datastore": "tasks", "id": "42"}' -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Remove an item from the datastore +$ slack datastore delete --datastore tasks '{"id": "42"}' + +# Remove an item from the datastore with an expression +$ slack datastore delete '{"datastore": "tasks", "id": "42"}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_get.md b/docs/reference/commands/slack_datastore_get.md index f79b8e5d..b73c8de4 100644 --- a/docs/reference/commands/slack_datastore_get.md +++ b/docs/reference/commands/slack_datastore_get.md @@ -2,7 +2,7 @@ Get an item from a datastore -## Synopsis +## Description Get an item from a datastore. @@ -13,17 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore get [flags] ``` -## Examples - -``` -# Get an item from the datastore -$ slack datastore get --datastore tasks '{"id": "42"}' - -# Get an item from the datastore with an expression -$ slack datastore get '{"datastore": "tasks", "id": "42"}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -33,7 +23,7 @@ $ slack datastore get '{"datastore": "tasks", "id": "42"}' --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -47,7 +37,17 @@ $ slack datastore get '{"datastore": "tasks", "id": "42"}' -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Get an item from the datastore +$ slack datastore get --datastore tasks '{"id": "42"}' + +# Get an item from the datastore with an expression +$ slack datastore get '{"datastore": "tasks", "id": "42"}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_put.md b/docs/reference/commands/slack_datastore_put.md index ddda038e..97544089 100644 --- a/docs/reference/commands/slack_datastore_put.md +++ b/docs/reference/commands/slack_datastore_put.md @@ -2,7 +2,7 @@ Create or replace an item in a datastore -## Synopsis +## Description Create or replace an item in a datastore. @@ -13,17 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore put [flags] ``` -## Examples - -``` -# Add a new entry to the datastore -$ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Add a new entry to the datastore with an expression -$ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -32,7 +22,7 @@ $ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description" --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -46,7 +36,17 @@ $ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description" -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Add a new entry to the datastore +$ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Add a new entry to the datastore with an expression +$ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_query.md b/docs/reference/commands/slack_datastore_query.md index 8ef5d003..c8e57039 100644 --- a/docs/reference/commands/slack_datastore_query.md +++ b/docs/reference/commands/slack_datastore_query.md @@ -2,7 +2,7 @@ Query a datastore for items -## Synopsis +## Description Query a datastore for items. @@ -13,23 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore query [flags] ``` -## Examples - -``` -# Collect a limited set of items from the datastore -$ slack datastore query --datastore tasks '{"limit": 8}' --output json - -# Collect items from the datastore starting at a cursor -$ slack datastore query --datastore tasks '{"cursor": "eyJfX2NWaV..."}' - -# Query the datastore for specific items -$ slack datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' - -# Query the datastore for specific items with only an expression -$ slack datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -40,7 +24,7 @@ $ slack datastore query '{"datastore": "tasks", "expression": "#status = :status --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -54,7 +38,23 @@ $ slack datastore query '{"datastore": "tasks", "expression": "#status = :status -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Collect a limited set of items from the datastore +$ slack datastore query --datastore tasks '{"limit": 8}' --output json + +# Collect items from the datastore starting at a cursor +$ slack datastore query --datastore tasks '{"cursor": "eyJfX2NWaV..."}' + +# Query the datastore for specific items +$ slack datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' + +# Query the datastore for specific items with only an expression +$ slack datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_update.md b/docs/reference/commands/slack_datastore_update.md index e725beb9..77fb20fa 100644 --- a/docs/reference/commands/slack_datastore_update.md +++ b/docs/reference/commands/slack_datastore_update.md @@ -2,7 +2,7 @@ Create or update an item in a datastore -## Synopsis +## Description Create or update an item in a datastore. @@ -13,17 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore update [flags] ``` -## Examples - -``` -# Update the entry in the datastore -$ slack datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Update the entry in the datastore with an expression -$ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' -``` - -## Options +## Flags ``` --datastore string the datastore used to store items @@ -32,7 +22,7 @@ $ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "descripti --unstable kick the tires of experimental features ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -46,7 +36,17 @@ $ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "descripti -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Update the entry in the datastore +$ slack datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Update the entry in the datastore with an expression +$ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' +``` + +## See also * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_delete.md b/docs/reference/commands/slack_delete.md index 675f67fb..8dcc2587 100644 --- a/docs/reference/commands/slack_delete.md +++ b/docs/reference/commands/slack_delete.md @@ -2,7 +2,7 @@ Delete the app -## Synopsis +## Description Uninstall the app from the team and permanently delete the app and all of its data @@ -10,23 +10,13 @@ Uninstall the app from the team and permanently delete the app and all of its da slack delete [flags] ``` -## Examples - -``` -# Delete an app and app info from a team -$ slack app delete - -# Delete a specific app from a team -$ slack app delete --team T0123456 --app local -``` - -## Options +## Flags ``` -h, --help help for delete ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -40,7 +30,17 @@ $ slack app delete --team T0123456 --app local -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Delete an app and app info from a team +$ slack app delete + +# Delete a specific app from a team +$ slack app delete --team T0123456 --app local +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_deploy.md b/docs/reference/commands/slack_deploy.md index e705c84d..83d7d541 100644 --- a/docs/reference/commands/slack_deploy.md +++ b/docs/reference/commands/slack_deploy.md @@ -2,7 +2,7 @@ Deploy the app to the Slack Platform -## Synopsis +## Description Deploy the app to the Slack Platform @@ -10,15 +10,7 @@ Deploy the app to the Slack Platform slack deploy [flags] ``` -## Examples - -``` -# Select the workspace to deploy to -$ slack platform deploy -$ slack platform deploy --team T0123456 # Deploy to a specific team -``` - -## Options +## Flags ``` -h, --help help for deploy @@ -27,7 +19,7 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team (or 'all' for all workspaces in the org) ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -41,7 +33,15 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Select the workspace to deploy to +$ slack platform deploy +$ slack platform deploy --team T0123456 # Deploy to a specific team +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_doctor.md b/docs/reference/commands/slack_doctor.md index c1fa0672..643e284e 100644 --- a/docs/reference/commands/slack_doctor.md +++ b/docs/reference/commands/slack_doctor.md @@ -2,7 +2,7 @@ Check and report on system and app information -## Synopsis +## Description Check and report on relevant system (and sometimes app) dependencies @@ -19,19 +19,13 @@ Unfortunately, the doctor command cannot heal all problems slack doctor [flags] ``` -## Examples - -``` -$ slack doctor # Create a status report of system dependencies -``` - -## Options +## Flags ``` -h, --help help for doctor ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -45,7 +39,13 @@ $ slack doctor # Create a status report of system dependencies -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack doctor # Create a status report of system dependencies +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_env.md b/docs/reference/commands/slack_env.md index 84e7b56f..68956751 100644 --- a/docs/reference/commands/slack_env.md +++ b/docs/reference/commands/slack_env.md @@ -2,7 +2,7 @@ Add, remove, or list environment variables -## Synopsis +## Description Add, remove, or list environment variables for apps deployed to Slack managed infrastructure. @@ -10,31 +10,19 @@ 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: [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/) +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) ``` slack env [flags] ``` -## Examples - -``` -$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable - -# List all environment variables -$ slack env list - -# Remove an environment variable -$ slack env remove MAGIC_PASSWORD -``` - -## Options +## Flags ``` -h, --help help for env ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -48,7 +36,19 @@ $ slack env remove MAGIC_PASSWORD -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable + +# List all environment variables +$ slack env list + +# Remove an environment variable +$ slack env remove MAGIC_PASSWORD +``` + +## See also * [slack](slack) - Slack command-line tool * [slack env add](slack_env_add) - Add an environment variable to the app diff --git a/docs/reference/commands/slack_env_add.md b/docs/reference/commands/slack_env_add.md index 207b7a05..a9a058cb 100644 --- a/docs/reference/commands/slack_env_add.md +++ b/docs/reference/commands/slack_env_add.md @@ -2,7 +2,7 @@ Add an environment variable to the app -## Synopsis +## Description Add an environment variable to an app deployed to Slack managed infrastructure. @@ -15,25 +15,14 @@ other apps can attempt to run the command with the --force flag. slack env add [flags] ``` -## Examples - -``` -# Prompt for an environment variable -$ slack env add -$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable - -# Prompt for an environment variable value -$ slack env add SECRET_PASSWORD -``` - -## Options +## Flags ``` -h, --help help for add --value string set the environment variable value ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -47,7 +36,18 @@ $ slack env add SECRET_PASSWORD -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Prompt for an environment variable +$ slack env add +$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable + +# Prompt for an environment variable value +$ slack env add SECRET_PASSWORD +``` + +## See also * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_env_list.md b/docs/reference/commands/slack_env_list.md index eb26caf2..40aed2a9 100644 --- a/docs/reference/commands/slack_env_list.md +++ b/docs/reference/commands/slack_env_list.md @@ -2,7 +2,7 @@ List all environment variables for the app -## Synopsis +## Description List all of the environment variables of an app deployed to Slack managed infrastructure. @@ -14,19 +14,13 @@ other apps can attempt to run the command with the --force flag. slack env list [flags] ``` -## Examples - -``` -$ slack env list # List all environment variables -``` - -## Options +## Flags ``` -h, --help help for list ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -40,7 +34,13 @@ $ slack env list # List all environment variables -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack env list # List all environment variables +``` + +## See also * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_env_remove.md b/docs/reference/commands/slack_env_remove.md index b81f4e30..d8d68e55 100644 --- a/docs/reference/commands/slack_env_remove.md +++ b/docs/reference/commands/slack_env_remove.md @@ -2,7 +2,7 @@ Remove an environment variable from the app -## Synopsis +## Description Remove an environment variable from an app deployed to Slack managed infrastructure. @@ -16,22 +16,14 @@ other apps can attempt to run the command with the --force flag. slack env remove [flags] ``` -## Examples - -``` -# Select an environment variable to remove -$ slack env remove -$ slack env remove MAGIC_PASSWORD # Remove an environment variable -``` - -## Options +## Flags ``` -h, --help help for remove --name string choose the environment variable name ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -45,7 +37,15 @@ $ slack env remove MAGIC_PASSWORD # Remove an environment variable -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Select an environment variable to remove +$ slack env remove +$ slack env remove MAGIC_PASSWORD # Remove an environment variable +``` + +## See also * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_external-auth.md b/docs/reference/commands/slack_external-auth.md index 8efa6658..bc9f9c71 100644 --- a/docs/reference/commands/slack_external-auth.md +++ b/docs/reference/commands/slack_external-auth.md @@ -2,42 +2,26 @@ Adjust settings of external authentication providers -## Synopsis +## Description 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: [https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication/](https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication/) +Explore providers: [https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication](https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication) ``` slack external-auth [flags] ``` -## Examples - -``` -# Initiate OAuth2 flow for a selected provider -$ slack external-auth add - -# Set client secret for an app and provider -$ slack external-auth add-secret - -# Remove authorization for a specific provider -$ slack external-auth remove - -# Select authorization for a specific provider in a workflow -$ slack external-auth select-auth -``` - -## Options +## Flags ``` -h, --help help for external-auth ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -51,7 +35,23 @@ $ slack external-auth select-auth -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Initiate OAuth2 flow for a selected provider +$ slack external-auth add + +# Set client secret for an app and provider +$ slack external-auth add-secret + +# Remove authorization for a specific provider +$ slack external-auth remove + +# Select authorization for a specific provider in a workflow +$ slack external-auth select-auth +``` + +## See also * [slack](slack) - Slack command-line tool * [slack external-auth add](slack_external-auth_add) - Initiate the OAuth2 flow for a provider diff --git a/docs/reference/commands/slack_external-auth_add-secret.md b/docs/reference/commands/slack_external-auth_add-secret.md index 14901281..b178e2ec 100644 --- a/docs/reference/commands/slack_external-auth_add-secret.md +++ b/docs/reference/commands/slack_external-auth_add-secret.md @@ -2,7 +2,7 @@ Add the client secret for a provider -## Synopsis +## Description Add the client secret for an external provider of a workflow app. @@ -15,17 +15,7 @@ other apps can attempt to run the command with the --force flag. slack external-auth add-secret [flags] ``` -## Examples - -``` -# Input the client secret for an app and provider -$ slack external-auth add-secret - -# Set the client secret for an app and provider -$ slack external-auth add-secret -p github -x ghp_token -``` - -## Options +## Flags ``` -h, --help help for add-secret @@ -33,7 +23,7 @@ $ slack external-auth add-secret -p github -x ghp_token -x, --secret string external auth client secret for the provider ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -47,7 +37,17 @@ $ slack external-auth add-secret -p github -x ghp_token -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Input the client secret for an app and provider +$ slack external-auth add-secret + +# Set the client secret for an app and provider +$ slack external-auth add-secret -p github -x ghp_token +``` + +## See also * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_add.md b/docs/reference/commands/slack_external-auth_add.md index 5f784bdf..058ecfb9 100644 --- a/docs/reference/commands/slack_external-auth_add.md +++ b/docs/reference/commands/slack_external-auth_add.md @@ -2,7 +2,7 @@ Initiate the OAuth2 flow for a provider -## Synopsis +## Description Initiate the OAuth2 flow for an external auth provider of a workflow app. @@ -13,24 +13,14 @@ other apps can attempt to run the command with the --force flag. slack external-auth add [flags] ``` -## Examples - -``` -# Select a provider to initiate the OAuth2 flow for -$ slack external-auth add - -# Initiate the OAuth2 flow for the provided provider -$ slack external-auth add -p github -``` - -## Options +## Flags ``` -h, --help help for add -p, --provider string the external auth Provider Key to add a secret to ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -44,7 +34,17 @@ $ slack external-auth add -p github -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Select a provider to initiate the OAuth2 flow for +$ slack external-auth add + +# Initiate the OAuth2 flow for the provided provider +$ slack external-auth add -p github +``` + +## See also * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_remove.md b/docs/reference/commands/slack_external-auth_remove.md index 32f688a1..1548544d 100644 --- a/docs/reference/commands/slack_external-auth_remove.md +++ b/docs/reference/commands/slack_external-auth_remove.md @@ -2,7 +2,7 @@ Remove the saved tokens for a provider -## Synopsis +## Description Remove tokens saved to external authentication providers of a workflow app. @@ -16,23 +16,7 @@ other apps can attempt to run the command with the --force flag. slack external-auth remove [flags] ``` -## Examples - -``` -# Remove a token from the selected provider -$ slack external-auth remove - -# Remove a token from the specified provider -$ slack external-auth remove -p github - -# Remove all tokens from the specified provider -$ slack external-auth remove --all -p github - -# Remove all tokens from all providers -$ slack external-auth remove --all -``` - -## Options +## Flags ``` -A, --all remove tokens for all providers or the specified provider @@ -40,7 +24,7 @@ $ slack external-auth remove --all -p, --provider string the external auth Provider Key to remove a token for ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -54,7 +38,23 @@ $ slack external-auth remove --all -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Remove a token from the selected provider +$ slack external-auth remove + +# Remove a token from the specified provider +$ slack external-auth remove -p github + +# Remove all tokens from the specified provider +$ slack external-auth remove --all -p github + +# Remove all tokens from all providers +$ slack external-auth remove --all +``` + +## See also * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_select-auth.md b/docs/reference/commands/slack_external-auth_select-auth.md index daaf56ff..682b8cad 100644 --- a/docs/reference/commands/slack_external-auth_select-auth.md +++ b/docs/reference/commands/slack_external-auth_select-auth.md @@ -2,7 +2,7 @@ Select developer authentication of a workflow -## Synopsis +## Description Select the saved developer authentication to use when calling external APIs from functions in a workflow app. @@ -14,14 +14,7 @@ other apps can attempt to run the command with the --force flag. slack external-auth select-auth [flags] ``` -## Examples - -``` -# Select the saved developer authentication in a workflow -$ slack external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com -``` - -## Options +## Flags ``` -E, --external-account string external account identifier for the provider @@ -30,7 +23,7 @@ $ slack external-auth select-auth --workflow #/workflows/workflow_callback --pro -W, --workflow string workflow to set developer authentication for ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -44,7 +37,14 @@ $ slack external-auth select-auth --workflow #/workflows/workflow_callback --pro -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Select the saved developer authentication in a workflow +$ slack external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com +``` + +## See also * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_feedback.md b/docs/reference/commands/slack_feedback.md index 3ffd6730..9c541c1c 100644 --- a/docs/reference/commands/slack_feedback.md +++ b/docs/reference/commands/slack_feedback.md @@ -2,7 +2,7 @@ Share feedback about your experience or project -## Synopsis +## Description Help us make the Slack Platform better with your feedback @@ -10,15 +10,7 @@ Help us make the Slack Platform better with your feedback 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 +## Flags ``` -h, --help help for feedback @@ -29,7 +21,7 @@ $ slack feedback --name slack-cli # Give feedback on the Slack CLI --no-prompt run command without prompts ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -43,7 +35,15 @@ $ slack feedback --name slack-cli # Give feedback on the Slack CLI -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Choose to give feedback on part of the Slack Platform +$ slack feedback +$ slack feedback --name slack-cli # Give feedback on the Slack CLI +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_function.md b/docs/reference/commands/slack_function.md index 8d8b76d3..bfef53ce 100644 --- a/docs/reference/commands/slack_function.md +++ b/docs/reference/commands/slack_function.md @@ -2,7 +2,7 @@ Manage the functions of an app -## Synopsis +## Description Functions are pieces of logic that complete the puzzle of workflows in Workflow Builder. Whatever that puzzle might be. @@ -10,32 +10,19 @@ Builder. Whatever that puzzle might be. Inspect and configure the custom functions included in an app with this command. Functions can be added as a step in Workflow Builder and shared among teammates. -Learn more about functions: [https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions](https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions/) +Learn more about functions: [https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions](https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions) ``` slack function [flags] ``` -## Examples - -``` -# Select a function and choose distribution options -$ slack function distribute - -# Distribute a function to everyone in a workspace -$ slack function distribute --name callback_id --everyone - -# Lookup the distribution information for a function -$ slack function distribute --info -``` - -## Options +## Flags ``` -h, --help help for function ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -49,7 +36,20 @@ $ slack function distribute --info -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Select a function and choose distribution options +$ slack function distribute + +# Distribute a function to everyone in a workspace +$ slack function distribute --name callback_id --everyone + +# Lookup the distribution information for a function +$ slack function distribute --info +``` + +## See also * [slack](slack) - Slack command-line tool * [slack function access](slack_function_access) - Adjust who can access functions published from an app diff --git a/docs/reference/commands/slack_function_access.md b/docs/reference/commands/slack_function_access.md index cf307b95..823ef35e 100644 --- a/docs/reference/commands/slack_function_access.md +++ b/docs/reference/commands/slack_function_access.md @@ -2,7 +2,7 @@ Adjust who can access functions published from an app -## Synopsis +## Description Adjust who can **access** functions published by an app when building a workflow in Workflow Builder. @@ -19,24 +19,7 @@ only. slack function access [flags] ``` -## Examples - -``` -# Select a function and choose access options -$ slack function access - -# Share a function with everyone in a workspace -$ slack function access --name callback_id --everyone - -# Revoke function access for multiple users -$ slack function access --name callback_id --revoke \ - --users USLACKBOT,U012345678,U0RHJTSPQ3 - -# Lookup access information for a function -$ slack function access --info -``` - -## Options +## Flags ``` -A, --app-collaborators grant access to only fellow app collaborators @@ -50,7 +33,7 @@ $ slack function access --info -U, --users string a comma-separated list of Slack user IDs ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -64,7 +47,24 @@ $ slack function access --info -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Select a function and choose access options +$ slack function access + +# Share a function with everyone in a workspace +$ slack function access --name callback_id --everyone + +# Revoke function access for multiple users +$ slack function access --name callback_id --revoke \ + --users USLACKBOT,U012345678,U0RHJTSPQ3 + +# Lookup access information for a function +$ slack function access --info +``` + +## See also * [slack function](slack_function) - Manage the functions of an app diff --git a/docs/reference/commands/slack_init.md b/docs/reference/commands/slack_init.md index 4e60977f..ac85be37 100644 --- a/docs/reference/commands/slack_init.md +++ b/docs/reference/commands/slack_init.md @@ -2,7 +2,7 @@ Initialize a project to work with the Slack CLI -## Synopsis +## Description Initializes a project to support the Slack CLI. @@ -30,19 +30,13 @@ Adds an existing app to your project (optional): slack init [flags] ``` -## Examples - -``` -$ slack init # Initialize a project -``` - -## Options +## Flags ``` -h, --help help for init ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -56,7 +50,13 @@ $ slack init # Initialize a project -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack init # Initialize a project +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_install.md b/docs/reference/commands/slack_install.md index 8bbe330b..be50b5dd 100644 --- a/docs/reference/commands/slack_install.md +++ b/docs/reference/commands/slack_install.md @@ -2,7 +2,7 @@ Install the app to a team -## Synopsis +## Description Install the app to a team @@ -10,24 +10,16 @@ Install the app to a team slack install [flags] ``` -## Examples - -``` -$ slack app install # Install a production app to a team - -# Install a production app to a specific team -$ slack app install --team T0123456 -``` - -## Options +## Flags ``` + -E, --environment string environment of app (local, deployed) -h, --help help for install --org-workspace-grant string grant access to a specific org workspace ID (or 'all' for all workspaces in the org) ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -41,7 +33,20 @@ $ slack app install --team T0123456 -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Install a production app to a team +$ slack app install + +# Install a production app to a specific team +$ slack app install --team T0123456 --environment deployed + +# Install a local dev app to a specific team +$ slack app install --team T0123456 --environment local +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_list.md b/docs/reference/commands/slack_list.md index c949ea10..a6a3b307 100644 --- a/docs/reference/commands/slack_list.md +++ b/docs/reference/commands/slack_list.md @@ -2,7 +2,7 @@ List all authorized accounts -## Synopsis +## Description List all authorized accounts @@ -10,19 +10,13 @@ List all authorized accounts slack list [flags] ``` -## Examples - -``` -$ slack auth list # List all authorized accounts -``` - -## Options +## Flags ``` -h, --help help for list ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -36,7 +30,13 @@ $ slack auth list # List all authorized accounts -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack auth list # List all authorized accounts +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_login.md b/docs/reference/commands/slack_login.md index f03b81b1..4187b969 100644 --- a/docs/reference/commands/slack_login.md +++ b/docs/reference/commands/slack_login.md @@ -2,7 +2,7 @@ Log in to a Slack account -## Synopsis +## Description Log in to a Slack account in your team @@ -10,23 +10,7 @@ Log in to a Slack account in your team slack login [flags] ``` -## Examples - -``` -# Login to a Slack account with prompts -$ slack auth login - -# Login to a Slack account without prompts, this returns a ticket -$ slack auth login --no-prompt - -# Complete login using ticket and challenge code -$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... - -# Login with a user token -$ slack auth login --token xoxp-... -``` - -## Options +## Flags ``` --challenge string provide a challenge code for pre-authenticated login @@ -36,7 +20,7 @@ $ slack auth login --token xoxp-... --token string provide a token for a pre-authenticated login ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -49,7 +33,23 @@ $ slack auth login --token xoxp-... -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Login to a Slack account with prompts +$ slack auth login + +# Login to a Slack account without prompts, this returns a ticket +$ slack auth login --no-prompt + +# Complete login using ticket and challenge code +$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... + +# Login with a user token +$ slack auth login --token xoxp-... +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_logout.md b/docs/reference/commands/slack_logout.md index ceaae8da..9132ec8d 100644 --- a/docs/reference/commands/slack_logout.md +++ b/docs/reference/commands/slack_logout.md @@ -2,7 +2,7 @@ Log out of a team -## Synopsis +## Description Log out of a team, removing any local credentials @@ -10,21 +10,14 @@ Log out of a team, removing any local credentials slack logout [flags] ``` -## Examples - -``` -$ slack auth logout # Select a team to log out of -$ slack auth logout --all # Log out of all team -``` - -## Options +## Flags ``` -A, --all logout of all workspaces -h, --help help for logout ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +31,14 @@ $ slack auth logout --all # Log out of all team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack auth logout # Select a team to log out of +$ slack auth logout --all # Log out of all team +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_manifest.md b/docs/reference/commands/slack_manifest.md index fb40bb45..2104964d 100644 --- a/docs/reference/commands/slack_manifest.md +++ b/docs/reference/commands/slack_manifest.md @@ -2,7 +2,7 @@ Print the app manifest of a project or app -## Synopsis +## Description Get the manifest of an app using either the "remote" values on app settings or from the "local" configurations. @@ -17,24 +17,14 @@ Project configurations use the "get-manifest" hook from ".slack/hooks.json". slack manifest [flags] ``` -## Examples - -``` -# Display the app manifest for the current project -$ slack manifest info - -# Validate the app manifest generated by a project -$ slack manifest validate -``` - -## Options +## Flags ``` -h, --help help for manifest --source string source of the app manifest ("local" or "remote") ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -48,7 +38,17 @@ $ slack manifest validate -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Display the app manifest for the current project +$ slack manifest info + +# Validate the app manifest generated by a project +$ slack manifest validate +``` + +## See also * [slack](slack) - Slack command-line tool * [slack manifest info](slack_manifest_info) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_manifest_info.md b/docs/reference/commands/slack_manifest_info.md index 96b9c8f9..a2421b88 100644 --- a/docs/reference/commands/slack_manifest_info.md +++ b/docs/reference/commands/slack_manifest_info.md @@ -2,7 +2,7 @@ Print the app manifest of a project or app -## Synopsis +## Description Get the manifest of an app using either the "remote" values on app settings or from the "local" configurations. @@ -15,27 +15,14 @@ Project configurations use the "get-manifest" hook from ".slack/hooks.json". slack manifest info [flags] ``` -## Examples - -``` -# Print the app manifest from project configurations -$ slack manifest info - -# Print the remote manifest of an app -$ slack manifest info --app A0123456789 - -# Print the app manifest gathered from App Config -$ slack manifest info --source remote -``` - -## Options +## Flags ``` -h, --help help for info --source string source of the app manifest ("local" or "remote") ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -49,7 +36,20 @@ $ slack manifest info --source remote -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Print the app manifest from project configurations +$ slack manifest info + +# Print the remote manifest of an app +$ slack manifest info --app A0123456789 + +# Print the app manifest gathered from App Config +$ slack manifest info --source remote +``` + +## See also * [slack manifest](slack_manifest) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_manifest_validate.md b/docs/reference/commands/slack_manifest_validate.md index 794ed4b7..921a5ab5 100644 --- a/docs/reference/commands/slack_manifest_validate.md +++ b/docs/reference/commands/slack_manifest_validate.md @@ -2,7 +2,7 @@ Validate the app manifest generated by a project -## Synopsis +## Description Validate the app manifest generated from a valid project directory @@ -10,20 +10,13 @@ Validate the app manifest generated from a valid project directory slack manifest validate [flags] ``` -## Examples - -``` -# Validate the app manifest generated by a project -$ slack manifest validate -``` - -## Options +## Flags ``` -h, --help help for validate ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -37,7 +30,14 @@ $ slack manifest validate -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Validate the app manifest generated by a project +$ slack manifest validate +``` + +## See also * [slack manifest](slack_manifest) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_platform.md b/docs/reference/commands/slack_platform.md index cc035534..dd3b3888 100644 --- a/docs/reference/commands/slack_platform.md +++ b/docs/reference/commands/slack_platform.md @@ -2,7 +2,7 @@ Deploy and run apps on the Slack Platform -## Synopsis +## Description Deploy and run apps on the Slack Platform @@ -10,21 +10,13 @@ Deploy and run apps on the Slack Platform slack platform [flags] ``` -## Examples - -``` -$ slack run # Run an app locally in a workspace -$ slack deploy --team T0123456 # Deploy to a specific team -$ slack activity -t # Continuously poll for new activity logs -``` - -## Options +## Flags ``` -h, --help help for platform ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +30,15 @@ $ slack activity -t # Continuously poll for new activity logs -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack run # Run an app locally in a workspace +$ slack deploy --team T0123456 # Deploy to a specific team +$ slack activity -t # Continuously poll for new activity logs +``` + +## See also * [slack](slack) - Slack command-line tool * [slack platform activity](slack_platform_activity) - Display the app activity logs from the Slack Platform diff --git a/docs/reference/commands/slack_platform_activity.md b/docs/reference/commands/slack_platform_activity.md index 68e29cfe..5b866ea9 100644 --- a/docs/reference/commands/slack_platform_activity.md +++ b/docs/reference/commands/slack_platform_activity.md @@ -2,7 +2,7 @@ Display the app activity logs from the Slack Platform -## Synopsis +## Description Display the app activity logs from the Slack Platform @@ -10,14 +10,7 @@ Display the app activity logs from the Slack Platform slack platform activity [flags] ``` -## Examples - -``` -$ slack platform activity # Display app activity logs for an app -$ slack platform activity -t # Continuously poll for new activity logs -``` - -## Options +## Flags ``` --component string component type to filter @@ -40,7 +33,7 @@ $ slack platform activity -t # Continuously poll for new activity logs --trace-id string trace id to filter ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -54,7 +47,14 @@ $ slack platform activity -t # Continuously poll for new activity logs -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack platform activity # Display app activity logs for an app +$ slack platform activity -t # Continuously poll for new activity logs +``` + +## See also * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_platform_deploy.md b/docs/reference/commands/slack_platform_deploy.md index 48040110..3d11f9e3 100644 --- a/docs/reference/commands/slack_platform_deploy.md +++ b/docs/reference/commands/slack_platform_deploy.md @@ -2,7 +2,7 @@ Deploy the app to the Slack Platform -## Synopsis +## Description Deploy the app to the Slack Platform @@ -10,15 +10,7 @@ Deploy the app to the Slack Platform slack platform deploy [flags] ``` -## Examples - -``` -# Select the workspace to deploy to -$ slack platform deploy -$ slack platform deploy --team T0123456 # Deploy to a specific team -``` - -## Options +## Flags ``` -h, --help help for deploy @@ -27,7 +19,7 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team (or 'all' for all workspaces in the org) ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -41,7 +33,15 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Select the workspace to deploy to +$ slack platform deploy +$ slack platform deploy --team T0123456 # Deploy to a specific team +``` + +## See also * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_platform_run.md b/docs/reference/commands/slack_platform_run.md index 62314829..2f9c6cb1 100644 --- a/docs/reference/commands/slack_platform_run.md +++ b/docs/reference/commands/slack_platform_run.md @@ -2,7 +2,7 @@ Start a local server to develop and run the app locally -## Synopsis +## Description Start a local server to develop and run the app locally while watching for file changes @@ -10,20 +10,7 @@ Start a local server to develop and run the app locally while watching for file slack platform run [flags] ``` -## Examples - -``` -# Start a local development server -$ slack platform run - -# Run a local development server with debug activity -$ slack platform run --activity-level debug - -# Run a local development server with cleanup -$ slack platform run --cleanup -``` - -## Options +## Flags ``` --activity-level string activity level to display (default "info") @@ -35,7 +22,7 @@ $ slack platform run --cleanup (or 'all' for all workspaces in the org) ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -49,7 +36,20 @@ $ slack platform run --cleanup -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Start a local development server +$ slack platform run + +# Run a local development server with debug activity +$ slack platform run --activity-level debug + +# Run a local development server with cleanup +$ slack platform run --cleanup +``` + +## See also * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_project.md b/docs/reference/commands/slack_project.md index 635b81e1..44f657b4 100644 --- a/docs/reference/commands/slack_project.md +++ b/docs/reference/commands/slack_project.md @@ -2,7 +2,7 @@ Create, manage, and doctor a project -## Synopsis +## Description Create, manage, and doctor a project and its configuration files. @@ -16,26 +16,13 @@ Check your project health and diagnose problems with the **doctor** command. slack project [flags] ``` -## Examples - -``` -# Creates a new Slack project from an optional template -$ slack project create - -# Initialize an existing project to work with the Slack CLI -$ slack project init - -# Creates a new Slack project from the sample gallery -$ slack project samples -``` - -## Options +## Flags ``` -h, --help help for project ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -49,7 +36,20 @@ $ slack project samples -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Creates a new Slack project from an optional template +$ slack project create + +# Initialize an existing project to work with the Slack CLI +$ slack project init + +# Creates a new Slack project from the sample gallery +$ slack project samples +``` + +## See also * [slack](slack) - Slack command-line tool * [slack project create](slack_project_create) - Create a new Slack project diff --git a/docs/reference/commands/slack_project_create.md b/docs/reference/commands/slack_project_create.md index c9e0c2f1..82cc0301 100644 --- a/docs/reference/commands/slack_project_create.md +++ b/docs/reference/commands/slack_project_create.md @@ -2,7 +2,7 @@ Create a new Slack project -## Synopsis +## Description Create a new Slack project on your local machine from an optional template @@ -10,17 +10,7 @@ Create a new Slack project on your local machine from an optional template slack project create [name] [flags] ``` -## Examples - -``` -# Create a new project from a template -$ slack create my-project - -# Start a new project from a specific template -$ slack create my-project -t slack-samples/deno-hello-world -``` - -## Options +## Flags ``` -b, --branch string name of git branch to checkout @@ -28,7 +18,7 @@ $ slack create my-project -t slack-samples/deno-hello-world -t, --template string template URL for your app ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -42,7 +32,17 @@ $ slack create my-project -t slack-samples/deno-hello-world -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Create a new project from a template +$ slack create my-project + +# Start a new project from a specific template +$ slack create my-project -t slack-samples/deno-hello-world +``` + +## See also * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_project_init.md b/docs/reference/commands/slack_project_init.md index d7fa12a8..5926d57c 100644 --- a/docs/reference/commands/slack_project_init.md +++ b/docs/reference/commands/slack_project_init.md @@ -2,7 +2,7 @@ Initialize a project to work with the Slack CLI -## Synopsis +## Description Initializes a project to support the Slack CLI. @@ -30,19 +30,13 @@ Adds an existing app to your project (optional): slack project init [flags] ``` -## Examples - -``` -$ slack init # Initialize a project -``` - -## Options +## Flags ``` -h, --help help for init ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -56,7 +50,13 @@ $ slack init # Initialize a project -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack init # Initialize a project +``` + +## See also * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_project_samples.md b/docs/reference/commands/slack_project_samples.md index 3dfe9510..a2899aa0 100644 --- a/docs/reference/commands/slack_project_samples.md +++ b/docs/reference/commands/slack_project_samples.md @@ -2,29 +2,25 @@ List available sample apps -## Synopsis +## Description List and create an app from the available samples ``` -slack project samples [flags] +slack project samples [name] [flags] ``` -## Examples - -``` -$ slack samples # Select a sample app to create -``` - -## Options +## Flags ``` -b, --branch string name of git branch to checkout -h, --help help for samples + --language string runtime for the app framework + ex: "deno", "node", "python" -t, --template string template URL for your app ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +34,13 @@ $ slack samples # Select a sample app to create -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack samples my-project # Select a sample app to create +``` + +## See also * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_run.md b/docs/reference/commands/slack_run.md index 6d3d436d..fb7517fa 100644 --- a/docs/reference/commands/slack_run.md +++ b/docs/reference/commands/slack_run.md @@ -2,7 +2,7 @@ Start a local server to develop and run the app locally -## Synopsis +## Description Start a local server to develop and run the app locally while watching for file changes @@ -10,20 +10,7 @@ Start a local server to develop and run the app locally while watching for file slack run [flags] ``` -## Examples - -``` -# Start a local development server -$ slack platform run - -# Run a local development server with debug activity -$ slack platform run --activity-level debug - -# Run a local development server with cleanup -$ slack platform run --cleanup -``` - -## Options +## Flags ``` --activity-level string activity level to display (default "info") @@ -35,7 +22,7 @@ $ slack platform run --cleanup (or 'all' for all workspaces in the org) ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -49,7 +36,20 @@ $ slack platform run --cleanup -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Start a local development server +$ slack platform run + +# Run a local development server with debug activity +$ slack platform run --activity-level debug + +# Run a local development server with cleanup +$ slack platform run --cleanup +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_samples.md b/docs/reference/commands/slack_samples.md index c4f4ac4f..7bb84a80 100644 --- a/docs/reference/commands/slack_samples.md +++ b/docs/reference/commands/slack_samples.md @@ -2,29 +2,25 @@ List available sample apps -## Synopsis +## Description List and create an app from the available samples ``` -slack samples [flags] +slack samples [name] [flags] ``` -## Examples - -``` -$ slack samples # Select a sample app to create -``` - -## Options +## Flags ``` -b, --branch string name of git branch to checkout -h, --help help for samples + --language string runtime for the app framework + ex: "deno", "node", "python" -t, --template string template URL for your app ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -38,7 +34,13 @@ $ slack samples # Select a sample app to create -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack samples my-project # Select a sample app to create +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_trigger.md b/docs/reference/commands/slack_trigger.md index f62c6687..05ba3463 100644 --- a/docs/reference/commands/slack_trigger.md +++ b/docs/reference/commands/slack_trigger.md @@ -2,7 +2,7 @@ List details of existing triggers -## Synopsis +## Description List details of existing triggers @@ -10,6 +10,26 @@ List details of existing triggers slack trigger [flags] ``` +## Flags + +``` + -h, --help help for trigger +``` + +## 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 ``` @@ -30,27 +50,7 @@ $ slack trigger list $ slack trigger update --trigger-id Ft01234ABCD ``` -## Options - -``` - -h, --help help for trigger -``` - -## 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 +## See also * [slack](slack) - Slack command-line tool * [slack trigger access](slack_trigger_access) - Manage who can use your triggers diff --git a/docs/reference/commands/slack_trigger_access.md b/docs/reference/commands/slack_trigger_access.md index 11d23bb9..f44386b1 100644 --- a/docs/reference/commands/slack_trigger_access.md +++ b/docs/reference/commands/slack_trigger_access.md @@ -2,7 +2,7 @@ Manage who can use your triggers -## Synopsis +## Description Manage who can use your triggers @@ -10,22 +10,7 @@ Manage who can use your triggers slack trigger access --trigger-id [flags] ``` -## Examples - -``` -# Grant everyone access to run a trigger -$ slack trigger access --trigger-id Ft01234ABCD --everyone - -# Grant certain channels access to run a trigger -$ slack trigger access --trigger-id Ft01234ABCD --grant \ - --channels C012345678 - -# Revoke certain users access to run a trigger -$ slack trigger access --trigger-id Ft01234ABCD --revoke \ - --users USLACKBOT,U012345678 -``` - -## Options +## Flags ``` -A, --app-collaborators grant permission to only app collaborators @@ -45,7 +30,7 @@ $ slack trigger access --trigger-id Ft01234ABCD --revoke \ -W, --workspaces string a comma-separated list of Slack workspace IDs ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -59,7 +44,22 @@ $ slack trigger access --trigger-id Ft01234ABCD --revoke \ -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Grant everyone access to run a trigger +$ slack trigger access --trigger-id Ft01234ABCD --everyone + +# Grant certain channels access to run a trigger +$ slack trigger access --trigger-id Ft01234ABCD --grant \ + --channels C012345678 + +# Revoke certain users access to run a trigger +$ slack trigger access --trigger-id Ft01234ABCD --revoke \ + --users USLACKBOT,U012345678 +``` + +## See also * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_create.md b/docs/reference/commands/slack_trigger_create.md index a0457d9d..59971143 100644 --- a/docs/reference/commands/slack_trigger_create.md +++ b/docs/reference/commands/slack_trigger_create.md @@ -2,7 +2,7 @@ Create a trigger for a workflow -## Synopsis +## Description Create a trigger to start a workflow @@ -10,20 +10,7 @@ Create a trigger to start a workflow slack trigger create [flags] ``` -## Examples - -``` -# Create a trigger by selecting an app and trigger definition -$ slack trigger create - -# Create a trigger from a definition file -$ slack trigger create --trigger-def "triggers/shortcut_trigger.ts" - -# Create a trigger for a workflow -$ slack trigger create --workflow "#/workflows/my_workflow" -``` - -## Options +## Flags ``` --description string the description of this trigger @@ -47,7 +34,7 @@ $ slack trigger create --workflow "#/workflows/my_workflow" "#/workflows/" ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -61,7 +48,20 @@ $ slack trigger create --workflow "#/workflows/my_workflow" -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Create a trigger by selecting an app and trigger definition +$ slack trigger create + +# Create a trigger from a definition file +$ slack trigger create --trigger-def "triggers/shortcut_trigger.ts" + +# Create a trigger for a workflow +$ slack trigger create --workflow "#/workflows/my_workflow" +``` + +## See also * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_delete.md b/docs/reference/commands/slack_trigger_delete.md index 386ebdaf..e43cca83 100644 --- a/docs/reference/commands/slack_trigger_delete.md +++ b/docs/reference/commands/slack_trigger_delete.md @@ -2,7 +2,7 @@ Delete an existing trigger -## Synopsis +## Description Delete an existing trigger @@ -10,24 +10,14 @@ Delete an existing trigger slack trigger delete --trigger-id [flags] ``` -## Examples - -``` -# Delete a specific trigger in a selected workspace -$ slack trigger delete --trigger-id Ft01234ABCD - -# Delete a specific trigger for an app -$ slack trigger delete --trigger-id Ft01234ABCD --app A0123456 -``` - -## Options +## Flags ``` -h, --help help for delete --trigger-id string the ID of the trigger ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -41,7 +31,17 @@ $ slack trigger delete --trigger-id Ft01234ABCD --app A0123456 -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Delete a specific trigger in a selected workspace +$ slack trigger delete --trigger-id Ft01234ABCD + +# Delete a specific trigger for an app +$ slack trigger delete --trigger-id Ft01234ABCD --app A0123456 +``` + +## See also * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_info.md b/docs/reference/commands/slack_trigger_info.md index b58b08bd..12064e01 100644 --- a/docs/reference/commands/slack_trigger_info.md +++ b/docs/reference/commands/slack_trigger_info.md @@ -2,7 +2,7 @@ Get details for a specific trigger -## Synopsis +## Description Get details for a specific trigger @@ -10,24 +10,14 @@ Get details for a specific trigger slack trigger info --trigger-id [flags] ``` -## Examples - -``` -# Get details for a specific trigger in a selected workspace -$ slack trigger info --trigger-id Ft01234ABCD - -# Get details for a specific trigger -$ slack trigger info --trigger-id Ft01234ABCD --app A0123456 -``` - -## Options +## Flags ``` -h, --help help for info --trigger-id string the ID of the trigger ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -41,7 +31,17 @@ $ slack trigger info --trigger-id Ft01234ABCD --app A0123456 -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Get details for a specific trigger in a selected workspace +$ slack trigger info --trigger-id Ft01234ABCD + +# Get details for a specific trigger +$ slack trigger info --trigger-id Ft01234ABCD --app A0123456 +``` + +## See also * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_list.md b/docs/reference/commands/slack_trigger_list.md index a46a0fe0..4bec07f6 100644 --- a/docs/reference/commands/slack_trigger_list.md +++ b/docs/reference/commands/slack_trigger_list.md @@ -2,7 +2,7 @@ List details of existing triggers -## Synopsis +## Description List details of existing triggers @@ -10,17 +10,7 @@ List details of existing triggers slack trigger list [flags] ``` -## Examples - -``` -# List details for all existing triggers -$ slack trigger list - -# List triggers for a specific app -$ slack trigger list --team T0123456 --app local -``` - -## Options +## Flags ``` -h, --help help for list @@ -28,7 +18,7 @@ $ slack trigger list --team T0123456 --app local -T, --type string Only display triggers of the given type, can be one of 'all', 'shortcut', 'event', 'scheduled', 'webhook', and 'external' (default "all") ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -42,7 +32,17 @@ $ slack trigger list --team T0123456 --app local -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# List details for all existing triggers +$ slack trigger list + +# List triggers for a specific app +$ slack trigger list --team T0123456 --app local +``` + +## See also * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_update.md b/docs/reference/commands/slack_trigger_update.md index 117b1f14..d4f0c0c1 100644 --- a/docs/reference/commands/slack_trigger_update.md +++ b/docs/reference/commands/slack_trigger_update.md @@ -2,7 +2,7 @@ Updates an existing trigger -## Synopsis +## Description Updates an existing trigger with the provided definition. Only supports full replacement, no partial update. @@ -10,18 +10,7 @@ Updates an existing trigger with the provided definition. Only supports full rep slack trigger update --trigger-id [flags] ``` -## Examples - -``` -# Update a trigger definition with a selected file -$ slack trigger update --trigger-id Ft01234ABCD - -# Update a trigger with a workflow id and title -$ slack trigger update --trigger-id Ft01234ABCD \ - --workflow "#/workflows/my_workflow" --title "Updated trigger" -``` - -## Options +## Flags ``` --description string the description of this trigger @@ -44,7 +33,7 @@ $ slack trigger update --trigger-id Ft01234ABCD \ "#/workflows/" ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -58,7 +47,18 @@ $ slack trigger update --trigger-id Ft01234ABCD \ -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +# Update a trigger definition with a selected file +$ slack trigger update --trigger-id Ft01234ABCD + +# Update a trigger with a workflow id and title +$ slack trigger update --trigger-id Ft01234ABCD \ + --workflow "#/workflows/my_workflow" --title "Updated trigger" +``` + +## See also * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_uninstall.md b/docs/reference/commands/slack_uninstall.md index c947a4d2..0fa31872 100644 --- a/docs/reference/commands/slack_uninstall.md +++ b/docs/reference/commands/slack_uninstall.md @@ -2,7 +2,7 @@ Uninstall the app from a team -## Synopsis +## Description Uninstall the app from a team without deleting the app or its data @@ -10,19 +10,13 @@ Uninstall the app from a team without deleting the app or its data slack uninstall [flags] ``` -## Examples - -``` -$ slack app uninstall # Uninstall an app from a team -``` - -## Options +## Flags ``` -h, --help help for uninstall ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -36,7 +30,13 @@ $ slack app uninstall # Uninstall an app from a team -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack app uninstall # Uninstall an app from a team +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_upgrade.md b/docs/reference/commands/slack_upgrade.md index 8267c6b7..60db40ad 100644 --- a/docs/reference/commands/slack_upgrade.md +++ b/docs/reference/commands/slack_upgrade.md @@ -2,7 +2,7 @@ Checks for available updates to the CLI or SDK -## Synopsis +## Description Checks for available updates to the CLI or the SDKs of a project @@ -14,19 +14,13 @@ The changelog can be found at [https://docs.slack.dev/changelog](https://docs.sl slack upgrade [flags] ``` -## Examples - -``` -$ slack upgrade # Check for any available updates -``` - -## Options +## Flags ``` -h, --help help for upgrade ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -40,7 +34,13 @@ $ slack upgrade # Check for any available updates -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## Examples + +``` +$ slack upgrade # Check for any available updates +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_version.md b/docs/reference/commands/slack_version.md index 2169942e..e049be3e 100644 --- a/docs/reference/commands/slack_version.md +++ b/docs/reference/commands/slack_version.md @@ -2,7 +2,7 @@ Print the version number -## Synopsis +## Description All software has versions. This is ours. @@ -30,21 +30,13 @@ Given a version number `v3.0.1-7-g822d09a`: 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 +## Flags ``` -h, --help help for version ``` -## Options inherited from parent commands +## Global flags ``` -a, --app string use a specific app ID or environment @@ -58,7 +50,15 @@ $ slack --version --skip-update # Print version and skip update check -v, --verbose print debug logging and additional info ``` -## SEE ALSO +## 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 +``` + +## See also * [slack](slack) - Slack command-line tool diff --git a/docs/reference/errors.md b/docs/reference/errors.md index 6c6714b8..0f982b0f 100644 --- a/docs/reference/errors.md +++ b/docs/reference/errors.md @@ -71,7 +71,7 @@ and some ways to remediate them. **Message**: Specified app and team are mismatched -**Remediation**: Try a different combination of --app, --team flags +**Remediation**: Try a different combination of `--app` and `--team` flags --- @@ -101,9 +101,9 @@ and some ways to remediate them. https://docs.slack.dev/tools/deno-slack-sdk -If you are using a Bolt framework, add a deploy hook then run: `slackk deploy` +If you are using a Bolt framework, add a deploy hook then run: `slack deploy` -Otherwise start your app for local development with: `slackk run` +Otherwise start your app for local development with: `slack run` --- @@ -123,7 +123,7 @@ Otherwise start your app for local development with: `slackk run` **Message**: The --app flag must be provided -**Remediation**: Choose a specific app with --app +**Remediation**: Choose a specific app with `--app ` --- @@ -226,7 +226,7 @@ Read about ROSI: https://docs.slack.dev/workflows/run-on-slack-infrastructure **Message**: Couldn't find a valid auth token for the Slack API -**Remediation**: You need to be logged in to at least 1 production (slack.com) team to use this command. Log into one with the `slackk login` command and try again. +**Remediation**: You need to be logged in to at least 1 production (slack.com) team to use this command. Log into one with the `slack login` command and try again. --- @@ -361,7 +361,7 @@ Move the .slack/cli.json file to .slack/hooks.json and try again. **Message**: Slack API requires the latest version of the Slack CLI -**Remediation**: You can upgrade to the latest version of the Slack CLI using the command: `slackk upgrade` +**Remediation**: You can upgrade to the latest version of the Slack CLI using the command: `slack upgrade` --- @@ -426,7 +426,7 @@ Approval is pending review **Message**: No authentication found for this team -**Remediation**: Use the command `slackk login` to login to this workspace +**Remediation**: Use the command `slack login` to login to this workspace --- @@ -498,6 +498,12 @@ Approval is pending review --- +### documentation_generation_failed {#documentation_generation_failed} + +**Message**: Failed to generate documentation + +--- + ### enterprise_not_found {#enterprise_not_found} **Message**: The `enterprise` was not found @@ -558,7 +564,7 @@ Approval is pending review **Message**: The name of the feedback is invalid -**Remediation**: View the feedback options with `slackk feedback --help` +**Remediation**: View the feedback options with `slack feedback --help` --- @@ -567,7 +573,7 @@ Approval is pending review **Message**: The name of the feedback is required **Remediation**: Please provide a `--name ` flag or remove the `--no-prompt` flag -View feedback options with `slackk feedback --help` +View feedback options with `slack feedback --help` --- @@ -681,7 +687,7 @@ View feedback options with `slackk feedback --help` **Message**: A valid installation of this app is required to take this action -**Remediation**: Install the app with `slackk install` +**Remediation**: Install the app with `slack install` --- @@ -705,7 +711,7 @@ View feedback options with `slackk feedback --help` **Remediation**: A valid Slack project includes the Slack hooks file: .slack/hooks.json -If this is a Slack project, you can initialize it with `slackk init` +If this is a Slack project, you can initialize it with `slack init` --- @@ -713,8 +719,8 @@ If this is a Slack project, you can initialize it with `slackk init` **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 +**Remediation**: Specify the environment with `--app local` or `--app deployed` +Or choose a specific app with `--app ` --- @@ -748,7 +754,7 @@ Or choose a specific app with --app **Message**: Your user account authorization isn't valid -**Remediation**: Your user account authorization may be expired or does not have permission to access the resource. Try to login to the same user account again using `slackk login`. +**Remediation**: Your user account authorization may be expired or does not have permission to access the resource. Try to login to the same user account again using `slack login`. --- @@ -756,7 +762,7 @@ Or choose a specific app with --app **Message**: The challenge code is invalid -**Remediation**: The previous slash command and challenge code have now expired. To retry, use `slackk login`, paste the slash command in any Slack channel, and enter the challenge code displayed by Slack. It is easiest to copy & paste the challenge code. +**Remediation**: The previous slash command and challenge code have now expired. To retry, use `slack login`, paste the slash command in any Slack channel, and enter the challenge code displayed by Slack. It is easiest to copy & paste the challenge code. --- @@ -785,7 +791,7 @@ Or choose a specific app with --app **Message**: The provided expression is not valid **Remediation**: Verify the expression you provided is valid JSON surrounded by quotations -Use `slackk datastore --help` for examples +Use `slack datastore --help` for examples --- @@ -818,7 +824,7 @@ Use `slackk datastore --help` for examples **Message**: A manifest does not exist at the provided source **Remediation**: Set 'manifest.source' to either "remote" or "local" in .slack/config.json -Read about manifest sourcing with the `slackk manifest info --help` command +Read about manifest sourcing with the `slack manifest info --help` command --- @@ -1052,7 +1058,7 @@ Read about manifest sourcing with the `slackk manifest info --help` command **Message**: Your login is out of date -**Remediation**: Run `slackk logout` and then `slackk login` again. +**Remediation**: Run `slack logout` and then `slack login` again. --- @@ -1118,7 +1124,7 @@ Read about manifest sourcing with the `slackk manifest info --help` command **Message**: You are either not logged in or your login session has expired -**Remediation**: Authorize your CLI with `slackk login` +**Remediation**: Authorize your CLI with `slack login` --- @@ -1193,7 +1199,7 @@ Read about manifest sourcing with the `slackk manifest info --help` command **Message**: Project manifest source is not valid **Remediation**: Set 'manifest.source' to either "remote" or "local" in .slack/config.json -Read about manifest sourcing with the `slackk manifest info --help` command +Read about manifest sourcing with the `slack manifest info --help` command --- @@ -1269,7 +1275,7 @@ Read about manifest sourcing with the `slackk manifest info --help` command **Message**: There was an error while reading the Slack hooks file (`.slack/hooks.json`) or running the `get-hooks` hook -**Remediation**: Run `slackk doctor` to check that your system dependencies are up-to-date. +**Remediation**: Run `slack doctor` to check that your system dependencies are up-to-date. --- @@ -1277,7 +1283,7 @@ Read about manifest sourcing with the `slackk manifest info --help` command **Message**: A script hook defined in the Slack Configuration file (`.slack/hooks.json`) returned an error -**Remediation**: Run `slackk doctor` to check that your system dependencies are up-to-date. +**Remediation**: Run `slack doctor` to check that your system dependencies are up-to-date. --- @@ -1292,7 +1298,7 @@ Read about manifest sourcing with the `slackk manifest info --help` command 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/hooks.json -You can create a hooks file manually or with the `slackk init` command. +You can create a hooks file manually or with the `slack init` command. When manually creating the hooks file, you must install the hook dependencies. @@ -1314,7 +1320,7 @@ When manually creating the hooks file, you must install the hook dependencies. **Message**: You are not logged into a team or have not installed an app -**Remediation**: Use the command `slackk login` to login and `slackk install` to install your app +**Remediation**: Use the command `slack login` to login and `slack install` to install your app --- @@ -1376,7 +1382,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 ` --- @@ -1420,7 +1426,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: Your access token has expired -**Remediation**: Use the command `slackk login` to authenticate again +**Remediation**: Use the command `slack login` to authenticate again --- @@ -1428,7 +1434,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: Your token has already been revoked -**Remediation**: Use the command `slackk login` to authenticate again +**Remediation**: Use the command `slack login` to authenticate again --- @@ -1436,7 +1442,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: An error occurred while rotating your access token -**Remediation**: Use the command `slackk login` to authenticate again +**Remediation**: Use the command `slack login` to authenticate again --- From a14253513b46ee5fcf23b206d939cb4fb2b48c1d Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Fri, 15 Aug 2025 12:57:30 -0700 Subject: [PATCH 3/4] build run --- docs/reference/commands/slackk.md | 69 ---------------- docs/reference/commands/slackk_activity.md | 60 -------------- docs/reference/commands/slackk_app.md | 53 ------------ docs/reference/commands/slackk_app_delete.md | 46 ----------- docs/reference/commands/slackk_app_install.md | 52 ------------ docs/reference/commands/slackk_app_link.md | 56 ------------- docs/reference/commands/slackk_app_list.md | 44 ---------- .../reference/commands/slackk_app_settings.md | 51 ------------ .../commands/slackk_app_uninstall.md | 42 ---------- docs/reference/commands/slackk_auth.md | 49 ----------- docs/reference/commands/slackk_auth_list.md | 42 ---------- docs/reference/commands/slackk_auth_login.md | 55 ------------- docs/reference/commands/slackk_auth_logout.md | 44 ---------- docs/reference/commands/slackk_auth_revoke.md | 42 ---------- docs/reference/commands/slackk_auth_token.md | 52 ------------ .../reference/commands/slackk_collaborator.md | 49 ----------- .../commands/slackk_collaborator_add.md | 44 ---------- .../commands/slackk_collaborator_list.md | 42 ---------- .../commands/slackk_collaborator_remove.md | 45 ----------- docs/reference/commands/slackk_create.md | 48 ----------- docs/reference/commands/slackk_datastore.md | 81 ------------------- .../commands/slackk_datastore_bulk-delete.md | 52 ------------ .../commands/slackk_datastore_bulk-get.md | 53 ------------ .../commands/slackk_datastore_bulk-put.md | 53 ------------ .../commands/slackk_datastore_count.md | 53 ------------ .../commands/slackk_datastore_delete.md | 52 ------------ .../commands/slackk_datastore_get.md | 53 ------------ .../commands/slackk_datastore_put.md | 52 ------------ .../commands/slackk_datastore_query.md | 60 -------------- .../commands/slackk_datastore_update.md | 52 ------------ docs/reference/commands/slackk_delete.md | 46 ----------- docs/reference/commands/slackk_deploy.md | 47 ----------- docs/reference/commands/slackk_doctor.md | 51 ------------ docs/reference/commands/slackk_env.md | 57 ------------- docs/reference/commands/slackk_env_add.md | 53 ------------ docs/reference/commands/slackk_env_list.md | 46 ----------- docs/reference/commands/slackk_env_remove.md | 51 ------------ .../commands/slackk_external-auth.md | 61 -------------- .../slackk_external-auth_add-secret.md | 53 ------------ .../commands/slackk_external-auth_add.md | 50 ------------ .../commands/slackk_external-auth_remove.md | 60 -------------- .../slackk_external-auth_select-auth.md | 50 ------------ docs/reference/commands/slackk_feedback.md | 49 ----------- docs/reference/commands/slackk_function.md | 56 ------------- .../commands/slackk_function_access.md | 70 ---------------- docs/reference/commands/slackk_init.md | 62 -------------- docs/reference/commands/slackk_install.md | 52 ------------ docs/reference/commands/slackk_list.md | 42 ---------- docs/reference/commands/slackk_login.md | 55 ------------- docs/reference/commands/slackk_logout.md | 44 ---------- docs/reference/commands/slackk_manifest.md | 56 ------------- .../commands/slackk_manifest_info.md | 55 ------------- .../commands/slackk_manifest_validate.md | 43 ---------- docs/reference/commands/slackk_platform.md | 47 ----------- .../commands/slackk_platform_activity.md | 60 -------------- .../commands/slackk_platform_deploy.md | 47 ----------- .../reference/commands/slackk_platform_run.md | 55 ------------- docs/reference/commands/slackk_project.md | 58 ------------- .../commands/slackk_project_create.md | 48 ----------- .../reference/commands/slackk_project_init.md | 62 -------------- .../commands/slackk_project_samples.md | 46 ----------- docs/reference/commands/slackk_run.md | 55 ------------- docs/reference/commands/slackk_samples.md | 46 ----------- docs/reference/commands/slackk_trigger.md | 62 -------------- .../commands/slackk_trigger_access.md | 65 --------------- .../commands/slackk_trigger_create.md | 67 --------------- .../commands/slackk_trigger_delete.md | 47 ----------- .../reference/commands/slackk_trigger_info.md | 47 ----------- .../reference/commands/slackk_trigger_list.md | 48 ----------- .../commands/slackk_trigger_update.md | 64 --------------- docs/reference/commands/slackk_uninstall.md | 42 ---------- docs/reference/commands/slackk_upgrade.md | 46 ----------- docs/reference/commands/slackk_version.md | 64 --------------- 73 files changed, 3831 deletions(-) delete mode 100644 docs/reference/commands/slackk.md delete mode 100644 docs/reference/commands/slackk_activity.md delete mode 100644 docs/reference/commands/slackk_app.md delete mode 100644 docs/reference/commands/slackk_app_delete.md delete mode 100644 docs/reference/commands/slackk_app_install.md delete mode 100644 docs/reference/commands/slackk_app_link.md delete mode 100644 docs/reference/commands/slackk_app_list.md delete mode 100644 docs/reference/commands/slackk_app_settings.md delete mode 100644 docs/reference/commands/slackk_app_uninstall.md delete mode 100644 docs/reference/commands/slackk_auth.md delete mode 100644 docs/reference/commands/slackk_auth_list.md delete mode 100644 docs/reference/commands/slackk_auth_login.md delete mode 100644 docs/reference/commands/slackk_auth_logout.md delete mode 100644 docs/reference/commands/slackk_auth_revoke.md delete mode 100644 docs/reference/commands/slackk_auth_token.md delete mode 100644 docs/reference/commands/slackk_collaborator.md delete mode 100644 docs/reference/commands/slackk_collaborator_add.md delete mode 100644 docs/reference/commands/slackk_collaborator_list.md delete mode 100644 docs/reference/commands/slackk_collaborator_remove.md delete mode 100644 docs/reference/commands/slackk_create.md delete mode 100644 docs/reference/commands/slackk_datastore.md delete mode 100644 docs/reference/commands/slackk_datastore_bulk-delete.md delete mode 100644 docs/reference/commands/slackk_datastore_bulk-get.md delete mode 100644 docs/reference/commands/slackk_datastore_bulk-put.md delete mode 100644 docs/reference/commands/slackk_datastore_count.md delete mode 100644 docs/reference/commands/slackk_datastore_delete.md delete mode 100644 docs/reference/commands/slackk_datastore_get.md delete mode 100644 docs/reference/commands/slackk_datastore_put.md delete mode 100644 docs/reference/commands/slackk_datastore_query.md delete mode 100644 docs/reference/commands/slackk_datastore_update.md delete mode 100644 docs/reference/commands/slackk_delete.md delete mode 100644 docs/reference/commands/slackk_deploy.md delete mode 100644 docs/reference/commands/slackk_doctor.md delete mode 100644 docs/reference/commands/slackk_env.md delete mode 100644 docs/reference/commands/slackk_env_add.md delete mode 100644 docs/reference/commands/slackk_env_list.md delete mode 100644 docs/reference/commands/slackk_env_remove.md delete mode 100644 docs/reference/commands/slackk_external-auth.md delete mode 100644 docs/reference/commands/slackk_external-auth_add-secret.md delete mode 100644 docs/reference/commands/slackk_external-auth_add.md delete mode 100644 docs/reference/commands/slackk_external-auth_remove.md delete mode 100644 docs/reference/commands/slackk_external-auth_select-auth.md delete mode 100644 docs/reference/commands/slackk_feedback.md delete mode 100644 docs/reference/commands/slackk_function.md delete mode 100644 docs/reference/commands/slackk_function_access.md delete mode 100644 docs/reference/commands/slackk_init.md delete mode 100644 docs/reference/commands/slackk_install.md delete mode 100644 docs/reference/commands/slackk_list.md delete mode 100644 docs/reference/commands/slackk_login.md delete mode 100644 docs/reference/commands/slackk_logout.md delete mode 100644 docs/reference/commands/slackk_manifest.md delete mode 100644 docs/reference/commands/slackk_manifest_info.md delete mode 100644 docs/reference/commands/slackk_manifest_validate.md delete mode 100644 docs/reference/commands/slackk_platform.md delete mode 100644 docs/reference/commands/slackk_platform_activity.md delete mode 100644 docs/reference/commands/slackk_platform_deploy.md delete mode 100644 docs/reference/commands/slackk_platform_run.md delete mode 100644 docs/reference/commands/slackk_project.md delete mode 100644 docs/reference/commands/slackk_project_create.md delete mode 100644 docs/reference/commands/slackk_project_init.md delete mode 100644 docs/reference/commands/slackk_project_samples.md delete mode 100644 docs/reference/commands/slackk_run.md delete mode 100644 docs/reference/commands/slackk_samples.md delete mode 100644 docs/reference/commands/slackk_trigger.md delete mode 100644 docs/reference/commands/slackk_trigger_access.md delete mode 100644 docs/reference/commands/slackk_trigger_create.md delete mode 100644 docs/reference/commands/slackk_trigger_delete.md delete mode 100644 docs/reference/commands/slackk_trigger_info.md delete mode 100644 docs/reference/commands/slackk_trigger_list.md delete mode 100644 docs/reference/commands/slackk_trigger_update.md delete mode 100644 docs/reference/commands/slackk_uninstall.md delete mode 100644 docs/reference/commands/slackk_upgrade.md delete mode 100644 docs/reference/commands/slackk_version.md diff --git a/docs/reference/commands/slackk.md b/docs/reference/commands/slackk.md deleted file mode 100644 index 1c3ce605..00000000 --- a/docs/reference/commands/slackk.md +++ /dev/null @@ -1,69 +0,0 @@ -## slackk - -Slack command-line tool - -### Synopsis - -{{Emoji "sparkles"}}CLI to create, run, and deploy Slack apps - -{{Emoji "books"}}Get started by reading the docs: {{LinkText "https://docs.slack.dev/tools/slack-cli"}} - -``` -slackk [flags] -``` - -### Examples - -``` -$ slackk login # Log in to your Slack account -$ slackk create # Create a new Slack app -$ slackk init # Initialize an existing Slack app -$ slackk run # Start a local development server -$ slackk deploy # Deploy to the Slack Platform -``` - -### Options - -``` - -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 - -h, --help help for slackk - --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 - -* [slackk activity](slackk_activity.md) - Display the app activity logs from the Slack Platform -* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed -* [slackk auth](slackk_auth.md) - Add and remove local team authorizations -* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators -* [slackk create](slackk_create.md) - Create a new Slack project -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore -* [slackk delete](slackk_delete.md) - Delete the app -* [slackk deploy](slackk_deploy.md) - Deploy the app to the Slack Platform -* [slackk doctor](slackk_doctor.md) - Check and report on system and app information -* [slackk env](slackk_env.md) - Add, remove, or list environment variables -* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers -* [slackk feedback](slackk_feedback.md) - Share feedback about your experience or project -* [slackk function](slackk_function.md) - Manage the functions of an app -* [slackk init](slackk_init.md) - Initialize a project to work with the Slack CLI -* [slackk install](slackk_install.md) - Install the app to a team -* [slackk list](slackk_list.md) - List all authorized accounts -* [slackk login](slackk_login.md) - Log in to a Slack account -* [slackk logout](slackk_logout.md) - Log out of a team -* [slackk manifest](slackk_manifest.md) - Print the app manifest of a project or app -* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform -* [slackk project](slackk_project.md) - Create, manage, and doctor a project -* [slackk run](slackk_run.md) - Start a local server to develop and run the app locally -* [slackk samples](slackk_samples.md) - List available sample apps -* [slackk trigger](slackk_trigger.md) - List details of existing triggers -* [slackk uninstall](slackk_uninstall.md) - Uninstall the app from a team -* [slackk upgrade](slackk_upgrade.md) - Checks for available updates to the CLI or SDK -* [slackk version](slackk_version.md) - Print the version number - diff --git a/docs/reference/commands/slackk_activity.md b/docs/reference/commands/slackk_activity.md deleted file mode 100644 index 4ce45505..00000000 --- a/docs/reference/commands/slackk_activity.md +++ /dev/null @@ -1,60 +0,0 @@ -## slackk activity - -Display the app activity logs from the Slack Platform - -### Synopsis - -Display the app activity logs from the Slack Platform - -``` -slackk activity [flags] -``` - -### Examples - -``` -$ slackk platform activity # Display app activity logs for an app -$ slackk platform activity -t # Continuously poll for new activity logs -``` - -### Options - -``` - --component string component type to filter - --component-id string component id to filter - (either a function id or workflow id) - --event string event type to filter - -h, --help help for activity - --idle int time to poll without results before exiting - in minutes (default 5) - -i, --interval int polling interval in seconds (default 3) - --level string minimum log level to display (default "info") - (trace, debug, info, warn, error, fatal) - --limit int limit the amount of logs retrieved (default 100) - --max-date-created int maximum timestamp to filter - (unix timestamp in microseconds) - --min-date-created int minimum timestamp to filter - (unix timestamp in microseconds) - --source string source (slack or developer) to filter - -t, --tail continuously poll for new activity - --trace-id string trace id to filter -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_app.md b/docs/reference/commands/slackk_app.md deleted file mode 100644 index ab266ed4..00000000 --- a/docs/reference/commands/slackk_app.md +++ /dev/null @@ -1,53 +0,0 @@ -## slackk app - -Install, uninstall, and list teams with the app installed - -### Synopsis - -Install, uninstall, and list teams with the app installed - -``` -slackk app [flags] -``` - -### Examples - -``` -$ slackk app install # Install a production app to a team -$ slackk app link # Link an existing app to the project -$ slackk app list # List all teams with the app installed -$ slackk app settings # Open app settings in a web browser -$ slackk app uninstall # Uninstall an app from a team -$ slackk app delete # Delete an app and app info from a team -``` - -### Options - -``` - -h, --help help for app -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk app delete](slackk_app_delete.md) - Delete the app -* [slackk app install](slackk_app_install.md) - Install the app to a team -* [slackk app link](slackk_app_link.md) - Add an existing app to the project -* [slackk app list](slackk_app_list.md) - List teams with the app installed -* [slackk app settings](slackk_app_settings.md) - Open app settings for configurations -* [slackk app uninstall](slackk_app_uninstall.md) - Uninstall the app from a team - diff --git a/docs/reference/commands/slackk_app_delete.md b/docs/reference/commands/slackk_app_delete.md deleted file mode 100644 index 568af13f..00000000 --- a/docs/reference/commands/slackk_app_delete.md +++ /dev/null @@ -1,46 +0,0 @@ -## slackk app delete - -Delete the app - -### Synopsis - -Uninstall the app from the team and permanently delete the app and all of its data - -``` -slackk app delete [flags] -``` - -### Examples - -``` -# Delete an app and app info from a team -$ slackk app delete - -# Delete a specific app from a team -$ slackk app delete --team T0123456 --app local -``` - -### Options - -``` - -h, --help help for delete -``` - -### 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 - -* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed - diff --git a/docs/reference/commands/slackk_app_install.md b/docs/reference/commands/slackk_app_install.md deleted file mode 100644 index ced0fbf1..00000000 --- a/docs/reference/commands/slackk_app_install.md +++ /dev/null @@ -1,52 +0,0 @@ -## slackk app install - -Install the app to a team - -### Synopsis - -Install the app to a team - -``` -slackk app install [flags] -``` - -### Examples - -``` -# Install a production app to a team -$ slackk app install - -# Install a production app to a specific team -$ slackk app install --team T0123456 --environment deployed - -# Install a local dev app to a specific team -$ slackk app install --team T0123456 --environment local -``` - -### Options - -``` - -E, --environment string environment of app (local, deployed) - -h, --help help for install - --org-workspace-grant string grant access to a specific org workspace ID - (or 'all' for all workspaces in the org) -``` - -### 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 - -* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed - diff --git a/docs/reference/commands/slackk_app_link.md b/docs/reference/commands/slackk_app_link.md deleted file mode 100644 index d656ffad..00000000 --- a/docs/reference/commands/slackk_app_link.md +++ /dev/null @@ -1,56 +0,0 @@ -## slackk app link - -Add an existing app to the project - -### Synopsis - -Saves an existing app to a project to be available to other commands. - -The provided App ID and Team ID are stored in the apps.json or apps.dev.json -files in the .slack directory of a project. - -The environment option decides how an app is handled and where information -should be stored. Production apps should be 'deployed' while apps used for -testing and development should be considered 'local'. - -Only one app can exist for each combination of Team ID and environment. - -``` -slackk app link [flags] -``` - -### Examples - -``` -# Add an existing app to a project -$ slackk app link - -# Add a specific app without using prompts -$ slackk app link --team T0123456789 --app A0123456789 --environment deployed -``` - -### Options - -``` - -E, --environment string environment to save existing app (local, deployed) - -h, --help help for link -``` - -### 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 - -* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed - diff --git a/docs/reference/commands/slackk_app_list.md b/docs/reference/commands/slackk_app_list.md deleted file mode 100644 index 749a0143..00000000 --- a/docs/reference/commands/slackk_app_list.md +++ /dev/null @@ -1,44 +0,0 @@ -## slackk app list - -List teams with the app installed - -### Synopsis - -List all teams that have installed the app - -``` -slackk app list [flags] -``` - -### Examples - -``` -$ slackk app list # List all teams with the app installed -``` - -### Options - -``` - --all-org-workspace-grants display all workspace grants for an app - installed to an organization - -h, --help help for list -``` - -### 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 - -* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed - diff --git a/docs/reference/commands/slackk_app_settings.md b/docs/reference/commands/slackk_app_settings.md deleted file mode 100644 index 5d2550ba..00000000 --- a/docs/reference/commands/slackk_app_settings.md +++ /dev/null @@ -1,51 +0,0 @@ -## slackk 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. - -``` -slackk app settings [flags] -``` - -### Examples - -``` -# Open app settings for a prompted app -$ slackk app settings - -# Open app settings for a specific app -$ slackk 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 - -* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed - diff --git a/docs/reference/commands/slackk_app_uninstall.md b/docs/reference/commands/slackk_app_uninstall.md deleted file mode 100644 index fed586a1..00000000 --- a/docs/reference/commands/slackk_app_uninstall.md +++ /dev/null @@ -1,42 +0,0 @@ -## slackk app uninstall - -Uninstall the app from a team - -### Synopsis - -Uninstall the app from a team without deleting the app or its data - -``` -slackk app uninstall [flags] -``` - -### Examples - -``` -$ slackk app uninstall # Uninstall an app from a team -``` - -### Options - -``` - -h, --help help for uninstall -``` - -### 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 - -* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed - diff --git a/docs/reference/commands/slackk_auth.md b/docs/reference/commands/slackk_auth.md deleted file mode 100644 index 5671584b..00000000 --- a/docs/reference/commands/slackk_auth.md +++ /dev/null @@ -1,49 +0,0 @@ -## slackk auth - -Add and remove local team authorizations - -### Synopsis - -Add and remove local team authorizations - -``` -slackk auth [flags] -``` - -### Examples - -``` -$ slackk auth list # List all authorized accounts -$ slackk auth login # Log in to a Slack account -$ slackk auth logout # Log out of a team -``` - -### Options - -``` - -h, --help help for auth -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk auth list](slackk_auth_list.md) - List all authorized accounts -* [slackk auth login](slackk_auth_login.md) - Log in to a Slack account -* [slackk auth logout](slackk_auth_logout.md) - Log out of a team -* [slackk auth revoke](slackk_auth_revoke.md) - Revoke an authentication token -* [slackk auth token](slackk_auth_token.md) - Collect a service token - diff --git a/docs/reference/commands/slackk_auth_list.md b/docs/reference/commands/slackk_auth_list.md deleted file mode 100644 index 1916d947..00000000 --- a/docs/reference/commands/slackk_auth_list.md +++ /dev/null @@ -1,42 +0,0 @@ -## slackk auth list - -List all authorized accounts - -### Synopsis - -List all authorized accounts - -``` -slackk auth list [flags] -``` - -### Examples - -``` -$ slackk auth list # List all authorized accounts -``` - -### Options - -``` - -h, --help help for list -``` - -### 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 - -* [slackk auth](slackk_auth.md) - Add and remove local team authorizations - diff --git a/docs/reference/commands/slackk_auth_login.md b/docs/reference/commands/slackk_auth_login.md deleted file mode 100644 index 8399e839..00000000 --- a/docs/reference/commands/slackk_auth_login.md +++ /dev/null @@ -1,55 +0,0 @@ -## slackk auth login - -Log in to a Slack account - -### Synopsis - -Log in to a Slack account in your team - -``` -slackk auth login [flags] -``` - -### Examples - -``` -# Login to a Slack account with prompts -$ slackk auth login - -# Login to a Slack account without prompts, this returns a ticket -$ slackk auth login --no-prompt - -# Complete login using ticket and challenge code -$ slackk auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... - -# Login with a user token -$ slackk auth login --token xoxp-... -``` - -### Options - -``` - --challenge string provide a challenge code for pre-authenticated login - -h, --help help for login - --no-prompt login without prompts using ticket and challenge code - --ticket string provide an auth ticket value - --token string provide a token for a pre-authenticated login -``` - -### 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 - -v, --verbose print debug logging and additional info -``` - -### SEE ALSO - -* [slackk auth](slackk_auth.md) - Add and remove local team authorizations - diff --git a/docs/reference/commands/slackk_auth_logout.md b/docs/reference/commands/slackk_auth_logout.md deleted file mode 100644 index d8ae6cec..00000000 --- a/docs/reference/commands/slackk_auth_logout.md +++ /dev/null @@ -1,44 +0,0 @@ -## slackk auth logout - -Log out of a team - -### Synopsis - -Log out of a team, removing any local credentials - -``` -slackk auth logout [flags] -``` - -### Examples - -``` -$ slackk auth logout # Select a team to log out of -$ slackk auth logout --all # Log out of all team -``` - -### Options - -``` - -A, --all logout of all workspaces - -h, --help help for logout -``` - -### 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 - -* [slackk auth](slackk_auth.md) - Add and remove local team authorizations - diff --git a/docs/reference/commands/slackk_auth_revoke.md b/docs/reference/commands/slackk_auth_revoke.md deleted file mode 100644 index a2b7d6cb..00000000 --- a/docs/reference/commands/slackk_auth_revoke.md +++ /dev/null @@ -1,42 +0,0 @@ -## slackk auth revoke - -Revoke an authentication token - -### Synopsis - -Revoke an authentication token - -``` -slackk auth revoke [flags] -``` - -### Examples - -``` -$ slackk auth revoke --token xoxp-1-4921830... # Revoke a service token -``` - -### Options - -``` - -h, --help help for revoke -``` - -### 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 - -* [slackk auth](slackk_auth.md) - Add and remove local team authorizations - diff --git a/docs/reference/commands/slackk_auth_token.md b/docs/reference/commands/slackk_auth_token.md deleted file mode 100644 index 61704a57..00000000 --- a/docs/reference/commands/slackk_auth_token.md +++ /dev/null @@ -1,52 +0,0 @@ -## slackk auth token - -Collect a service token - -### Synopsis - -Log in to a Slack account in your team - -``` -slackk auth token [flags] -``` - -### Examples - -``` -# Create a service token with prompts -$ slackk auth token - -# Gather a service token without prompts, this returns a ticket -$ slackk auth token --no-prompt - -# Complete authentication using a ticket and challenge code -$ slackk auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... -``` - -### Options - -``` - --challenge string provide a challenge code for pre-authenticated login - -h, --help help for token - --no-prompt login without prompts using ticket and challenge code - --ticket string provide an auth ticket value -``` - -### 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 - -* [slackk auth](slackk_auth.md) - Add and remove local team authorizations - diff --git a/docs/reference/commands/slackk_collaborator.md b/docs/reference/commands/slackk_collaborator.md deleted file mode 100644 index 57192e79..00000000 --- a/docs/reference/commands/slackk_collaborator.md +++ /dev/null @@ -1,49 +0,0 @@ -## slackk collaborator - -Manage app collaborators - -### Synopsis - -Manage app collaborators - -``` -slackk collaborator [flags] -``` - -### Examples - -``` -$ slackk collaborator add bots@slack.com # Add a collaborator from email -$ slackk collaborator list # List all of the collaborators - -# Remove a collaborator by user ID -$ slackk collaborator remove USLACKBOT -``` - -### Options - -``` - -h, --help help for collaborator -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk collaborator add](slackk_collaborator_add.md) - Add a new collaborator to the app -* [slackk collaborator list](slackk_collaborator_list.md) - List all collaborators of an app -* [slackk collaborator remove](slackk_collaborator_remove.md) - Remove a collaborator from an app - diff --git a/docs/reference/commands/slackk_collaborator_add.md b/docs/reference/commands/slackk_collaborator_add.md deleted file mode 100644 index 66c5f4aa..00000000 --- a/docs/reference/commands/slackk_collaborator_add.md +++ /dev/null @@ -1,44 +0,0 @@ -## slackk collaborator add - -Add a new collaborator to the app - -### Synopsis - -Add a collaborator to your app by Slack email address or user ID - -``` -slackk collaborator add [email|user_id] [flags] -``` - -### Examples - -``` -$ slackk collaborator add # Add a collaborator via prompt -$ slackk collaborator add bot@slack.com # Add a collaborator from email -$ slackk collaborator add USLACKBOT # Add a collaborator by user ID -``` - -### Options - -``` - -h, --help help for add -``` - -### 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 - -* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators - diff --git a/docs/reference/commands/slackk_collaborator_list.md b/docs/reference/commands/slackk_collaborator_list.md deleted file mode 100644 index bd6ce819..00000000 --- a/docs/reference/commands/slackk_collaborator_list.md +++ /dev/null @@ -1,42 +0,0 @@ -## slackk collaborator list - -List all collaborators of an app - -### Synopsis - -List all collaborators of an app - -``` -slackk collaborator list [flags] -``` - -### Examples - -``` -$ slackk collaborator list # List all of the collaborators -``` - -### Options - -``` - -h, --help help for list -``` - -### 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 - -* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators - diff --git a/docs/reference/commands/slackk_collaborator_remove.md b/docs/reference/commands/slackk_collaborator_remove.md deleted file mode 100644 index 6167ca17..00000000 --- a/docs/reference/commands/slackk_collaborator_remove.md +++ /dev/null @@ -1,45 +0,0 @@ -## slackk collaborator remove - -Remove a collaborator from an app - -### Synopsis - -Remove a collaborator from an app by Slack email address or user ID - -``` -slackk collaborator remove [email|user_id] [flags] -``` - -### Examples - -``` -# Remove collaborator on prompt -$ slackk collaborator remove -$ slackk collaborator remove bot@slack.com # Remove collaborator by email -$ slackk collaborator remove USLACKBOT # Remove collaborator using ID -``` - -### Options - -``` - -h, --help help for remove -``` - -### 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 - -* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators - diff --git a/docs/reference/commands/slackk_create.md b/docs/reference/commands/slackk_create.md deleted file mode 100644 index bf1aaf8c..00000000 --- a/docs/reference/commands/slackk_create.md +++ /dev/null @@ -1,48 +0,0 @@ -## slackk create - -Create a new Slack project - -### Synopsis - -Create a new Slack project on your local machine from an optional template - -``` -slackk create [name] [flags] -``` - -### Examples - -``` -# Create a new project from a template -$ slackk create my-project - -# Start a new project from a specific template -$ slackk create my-project -t slack-samples/deno-hello-world -``` - -### Options - -``` - -b, --branch string name of git branch to checkout - -h, --help help for create - -t, --template string template URL for your app -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_datastore.md b/docs/reference/commands/slackk_datastore.md deleted file mode 100644 index 1b85670b..00000000 --- a/docs/reference/commands/slackk_datastore.md +++ /dev/null @@ -1,81 +0,0 @@ -## slackk datastore - -Interact with an app's datastore - -### Synopsis - -Interact with the items stored in an app's datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -Discover the datastores: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores"}} - -``` -slackk datastore [flags] -``` - -### Examples - -``` -# Add a new entry to the datastore -$ slackk datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Add two new entries to the datastore -$ slackk datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' - -# Update the entry in the datastore -$ slackk datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Get an item from the datastore -$ slackk datastore get --datastore tasks '{"id": "42"}' - -# Get two items from datastore -$ slackk datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' - -# Remove an item from the datastore -$ slackk datastore delete --datastore tasks '{"id": "42"}' - -# Remove two items from the datastore -$ slackk datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' - -# Query the datastore for specific items -$ slackk datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' - -# Count number of items in datastore -$ slackk datastore count --datastore tasks -``` - -### Options - -``` - -h, --help help for datastore -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk datastore bulk-delete](slackk_datastore_bulk-delete.md) - Delete multiple items from a datastore -* [slackk datastore bulk-get](slackk_datastore_bulk-get.md) - Get multiple items from a datastore -* [slackk datastore bulk-put](slackk_datastore_bulk-put.md) - Create or replace a list of items in a datastore -* [slackk datastore count](slackk_datastore_count.md) - Count the number of items in a datastore -* [slackk datastore delete](slackk_datastore_delete.md) - Delete an item from a datastore -* [slackk datastore get](slackk_datastore_get.md) - Get an item from a datastore -* [slackk datastore put](slackk_datastore_put.md) - Create or replace an item in a datastore -* [slackk datastore query](slackk_datastore_query.md) - Query a datastore for items -* [slackk datastore update](slackk_datastore_update.md) - Create or update an item in a datastore - diff --git a/docs/reference/commands/slackk_datastore_bulk-delete.md b/docs/reference/commands/slackk_datastore_bulk-delete.md deleted file mode 100644 index 74c92c7e..00000000 --- a/docs/reference/commands/slackk_datastore_bulk-delete.md +++ /dev/null @@ -1,52 +0,0 @@ -## slackk datastore bulk-delete - -Delete multiple items from a datastore - -### Synopsis - -Delete multiple items from a datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore bulk-delete [flags] -``` - -### Examples - -``` -# Delete two items from the datastore -$ slackk datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' - -# Delete two items from the datastore with an expression -$ slackk datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for bulk-delete - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_bulk-get.md b/docs/reference/commands/slackk_datastore_bulk-get.md deleted file mode 100644 index 9832abc1..00000000 --- a/docs/reference/commands/slackk_datastore_bulk-get.md +++ /dev/null @@ -1,53 +0,0 @@ -## slackk datastore bulk-get - -Get multiple items from a datastore - -### Synopsis - -Get multiple items from a datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore bulk-get [flags] -``` - -### Examples - -``` -# Get two items from datastore -$ slackk datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' - -# Get two items from datastore with an expression -$ slackk datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for bulk-get - --output string output format: text, json (default "text") - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_bulk-put.md b/docs/reference/commands/slackk_datastore_bulk-put.md deleted file mode 100644 index 5d6e22e3..00000000 --- a/docs/reference/commands/slackk_datastore_bulk-put.md +++ /dev/null @@ -1,53 +0,0 @@ -## slackk datastore bulk-put - -Create or replace a list of items in a datastore - -### Synopsis - -Create or replace a list of items in a datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore bulk-put [flags] -``` - -### Examples - -``` -# Create or replace two new entries in the datastore -$ slackk datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' - -# Create or replace two new entries in the datastore with an expression -$ slackk datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' -``` - -### Options - -``` - --datastore string the datastore used to store items - --from-file string store multiple items from a file of JSON Lines - -h, --help help for bulk-put - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_count.md b/docs/reference/commands/slackk_datastore_count.md deleted file mode 100644 index 2757b152..00000000 --- a/docs/reference/commands/slackk_datastore_count.md +++ /dev/null @@ -1,53 +0,0 @@ -## slackk datastore count - -Count the number of items in a datastore - -### Synopsis - -Count the number of items in a datastore that match a query expression or just -all of the items in the datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore count [expression] [flags] -``` - -### Examples - -``` -# Count all items in a datastore -$ slackk datastore count --datastore tasks - -# Count number of items in datastore that match a query -$ slackk datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for count - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_delete.md b/docs/reference/commands/slackk_datastore_delete.md deleted file mode 100644 index 15a9eb8b..00000000 --- a/docs/reference/commands/slackk_datastore_delete.md +++ /dev/null @@ -1,52 +0,0 @@ -## slackk datastore delete - -Delete an item from a datastore - -### Synopsis - -Delete an item from a datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore delete [flags] -``` - -### Examples - -``` -# Remove an item from the datastore -$ slackk datastore delete --datastore tasks '{"id": "42"}' - -# Remove an item from the datastore with an expression -$ slackk datastore delete '{"datastore": "tasks", "id": "42"}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for delete - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_get.md b/docs/reference/commands/slackk_datastore_get.md deleted file mode 100644 index 5da589b9..00000000 --- a/docs/reference/commands/slackk_datastore_get.md +++ /dev/null @@ -1,53 +0,0 @@ -## slackk datastore get - -Get an item from a datastore - -### Synopsis - -Get an item from a datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore get [flags] -``` - -### Examples - -``` -# Get an item from the datastore -$ slackk datastore get --datastore tasks '{"id": "42"}' - -# Get an item from the datastore with an expression -$ slackk datastore get '{"datastore": "tasks", "id": "42"}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for get - --output string output format: text, json (default "text") - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_put.md b/docs/reference/commands/slackk_datastore_put.md deleted file mode 100644 index d53ffcbb..00000000 --- a/docs/reference/commands/slackk_datastore_put.md +++ /dev/null @@ -1,52 +0,0 @@ -## slackk datastore put - -Create or replace an item in a datastore - -### Synopsis - -Create or replace an item in a datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore put [flags] -``` - -### Examples - -``` -# Add a new entry to the datastore -$ slackk datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Add a new entry to the datastore with an expression -$ slackk datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for put - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_query.md b/docs/reference/commands/slackk_datastore_query.md deleted file mode 100644 index 5e176ec9..00000000 --- a/docs/reference/commands/slackk_datastore_query.md +++ /dev/null @@ -1,60 +0,0 @@ -## slackk datastore query - -Query a datastore for items - -### Synopsis - -Query a datastore for items. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore query [flags] -``` - -### Examples - -``` -# Collect a limited set of items from the datastore -$ slackk datastore query --datastore tasks '{"limit": 8}' --output json - -# Collect items from the datastore starting at a cursor -$ slackk datastore query --datastore tasks '{"cursor": "eyJfX2NWaV..."}' - -# Query the datastore for specific items -$ slackk datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' - -# Query the datastore for specific items with only an expression -$ slackk datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for query - --output string output format: text, json (default "text") - --show only construct a JSON expression - --to-file string save items directly to a file as JSON Lines - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_datastore_update.md b/docs/reference/commands/slackk_datastore_update.md deleted file mode 100644 index 26f4fffd..00000000 --- a/docs/reference/commands/slackk_datastore_update.md +++ /dev/null @@ -1,52 +0,0 @@ -## slackk datastore update - -Create or update an item in a datastore - -### Synopsis - -Create or update an item in a datastore. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk datastore update [flags] -``` - -### Examples - -``` -# Update the entry in the datastore -$ slackk datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Update the entry in the datastore with an expression -$ slackk datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' -``` - -### Options - -``` - --datastore string the datastore used to store items - -h, --help help for update - --show only construct a JSON expression - --unstable kick the tires of experimental features -``` - -### 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 - -* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore - diff --git a/docs/reference/commands/slackk_delete.md b/docs/reference/commands/slackk_delete.md deleted file mode 100644 index f97b0887..00000000 --- a/docs/reference/commands/slackk_delete.md +++ /dev/null @@ -1,46 +0,0 @@ -## slackk delete - -Delete the app - -### Synopsis - -Uninstall the app from the team and permanently delete the app and all of its data - -``` -slackk delete [flags] -``` - -### Examples - -``` -# Delete an app and app info from a team -$ slackk app delete - -# Delete a specific app from a team -$ slackk app delete --team T0123456 --app local -``` - -### Options - -``` - -h, --help help for delete -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_deploy.md b/docs/reference/commands/slackk_deploy.md deleted file mode 100644 index 475e12dd..00000000 --- a/docs/reference/commands/slackk_deploy.md +++ /dev/null @@ -1,47 +0,0 @@ -## slackk deploy - -Deploy the app to the Slack Platform - -### Synopsis - -Deploy the app to the Slack Platform - -``` -slackk deploy [flags] -``` - -### Examples - -``` -# Select the workspace to deploy to -$ slackk platform deploy -$ slackk platform deploy --team T0123456 # Deploy to a specific team -``` - -### Options - -``` - -h, --help help for deploy - --hide-triggers do not list triggers and skip trigger creation prompts - --org-workspace-grant string grant access to a specific org workspace ID - (or 'all' for all workspaces in the org) -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_doctor.md b/docs/reference/commands/slackk_doctor.md deleted file mode 100644 index 6f6f38a2..00000000 --- a/docs/reference/commands/slackk_doctor.md +++ /dev/null @@ -1,51 +0,0 @@ -## slackk doctor - -Check and report on system and app information - -### Synopsis - -Check and report on relevant system (and sometimes app) dependencies - -System dependencies can be reviewed from any directory -* This includes operating system information and Deno and Git versions - -While app dependencies are only shown within a project directory -* This includes the Deno Slack SDK, API, and hooks versions of an app -* New versions will be listed if there are any updates available - -Unfortunately, the doctor command cannot heal all problems - -``` -slackk doctor [flags] -``` - -### Examples - -``` -$ slackk doctor # Create a status report of system dependencies -``` - -### Options - -``` - -h, --help help for doctor -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_env.md b/docs/reference/commands/slackk_env.md deleted file mode 100644 index bca21a87..00000000 --- a/docs/reference/commands/slackk_env.md +++ /dev/null @@ -1,57 +0,0 @@ -## slackk env - -Add, remove, or list environment variables - -### Synopsis - -Add, remove, or list environment variables for apps deployed to Slack managed -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: {{LinkText "https://docs.slack.dev/tools/slack-cli/guides/using-environment-variables-with-the-slack-cli"}} - -``` -slackk env [flags] -``` - -### Examples - -``` -$ slackk env add MAGIC_PASSWORD abracadbra # Add an environment variable - -# List all environment variables -$ slackk env list - -# Remove an environment variable -$ slackk env remove MAGIC_PASSWORD -``` - -### Options - -``` - -h, --help help for env -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk env add](slackk_env_add.md) - Add an environment variable to the app -* [slackk env list](slackk_env_list.md) - List all environment variables for the app -* [slackk env remove](slackk_env_remove.md) - Remove an environment variable from the app - diff --git a/docs/reference/commands/slackk_env_add.md b/docs/reference/commands/slackk_env_add.md deleted file mode 100644 index f4250447..00000000 --- a/docs/reference/commands/slackk_env_add.md +++ /dev/null @@ -1,53 +0,0 @@ -## slackk env add - -Add an environment variable to the app - -### Synopsis - -Add an environment variable to an app deployed to Slack managed infrastructure. - -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. - -``` -slackk env add [flags] -``` - -### Examples - -``` -# Prompt for an environment variable -$ slackk env add -$ slackk env add MAGIC_PASSWORD abracadbra # Add an environment variable - -# Prompt for an environment variable value -$ slackk env add SECRET_PASSWORD -``` - -### Options - -``` - -h, --help help for add - --value string set the environment variable value -``` - -### 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 - -* [slackk env](slackk_env.md) - Add, remove, or list environment variables - diff --git a/docs/reference/commands/slackk_env_list.md b/docs/reference/commands/slackk_env_list.md deleted file mode 100644 index 2208217b..00000000 --- a/docs/reference/commands/slackk_env_list.md +++ /dev/null @@ -1,46 +0,0 @@ -## slackk env list - -List all environment variables for the app - -### Synopsis - -List all of the environment variables of an app deployed to Slack managed -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. - -``` -slackk env list [flags] -``` - -### Examples - -``` -$ slackk env list # List all environment variables -``` - -### Options - -``` - -h, --help help for list -``` - -### 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 - -* [slackk env](slackk_env.md) - Add, remove, or list environment variables - diff --git a/docs/reference/commands/slackk_env_remove.md b/docs/reference/commands/slackk_env_remove.md deleted file mode 100644 index 57363835..00000000 --- a/docs/reference/commands/slackk_env_remove.md +++ /dev/null @@ -1,51 +0,0 @@ -## slackk env remove - -Remove an environment variable from the app - -### Synopsis - -Remove an environment variable from an app deployed to Slack managed -infrastructure. - -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. - -``` -slackk env remove [flags] -``` - -### Examples - -``` -# Select an environment variable to remove -$ slackk env remove -$ slackk env remove MAGIC_PASSWORD # Remove an environment variable -``` - -### Options - -``` - -h, --help help for remove - --name string choose the environment variable name -``` - -### 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 - -* [slackk env](slackk_env.md) - Add, remove, or list environment variables - diff --git a/docs/reference/commands/slackk_external-auth.md b/docs/reference/commands/slackk_external-auth.md deleted file mode 100644 index a07d6e5a..00000000 --- a/docs/reference/commands/slackk_external-auth.md +++ /dev/null @@ -1,61 +0,0 @@ -## slackk external-auth - -Adjust settings of external authentication providers - -### Synopsis - -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: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication"}} - -``` -slackk external-auth [flags] -``` - -### Examples - -``` -# Initiate OAuth2 flow for a selected provider -$ slackk external-auth add - -# Set client secret for an app and provider -$ slackk external-auth add-secret - -# Remove authorization for a specific provider -$ slackk external-auth remove - -# Select authorization for a specific provider in a workflow -$ slackk external-auth select-auth -``` - -### Options - -``` - -h, --help help for external-auth -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk external-auth add](slackk_external-auth_add.md) - Initiate the OAuth2 flow for a provider -* [slackk external-auth add-secret](slackk_external-auth_add-secret.md) - Add the client secret for a provider -* [slackk external-auth remove](slackk_external-auth_remove.md) - Remove the saved tokens for a provider -* [slackk external-auth select-auth](slackk_external-auth_select-auth.md) - Select developer authentication of a workflow - diff --git a/docs/reference/commands/slackk_external-auth_add-secret.md b/docs/reference/commands/slackk_external-auth_add-secret.md deleted file mode 100644 index f16c8467..00000000 --- a/docs/reference/commands/slackk_external-auth_add-secret.md +++ /dev/null @@ -1,53 +0,0 @@ -## slackk external-auth add-secret - -Add the client secret for a provider - -### Synopsis - -Add the client secret for an external provider of a workflow app. - -This secret will be used when initiating the OAuth2 flow. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk external-auth add-secret [flags] -``` - -### Examples - -``` -# Input the client secret for an app and provider -$ slackk external-auth add-secret - -# Set the client secret for an app and provider -$ slackk external-auth add-secret -p github -x ghp_token -``` - -### Options - -``` - -h, --help help for add-secret - -p, --provider string the external auth Provider Key to add a secret to - -x, --secret string external auth client secret for the provider -``` - -### 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 - -* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers - diff --git a/docs/reference/commands/slackk_external-auth_add.md b/docs/reference/commands/slackk_external-auth_add.md deleted file mode 100644 index aba4557d..00000000 --- a/docs/reference/commands/slackk_external-auth_add.md +++ /dev/null @@ -1,50 +0,0 @@ -## slackk external-auth add - -Initiate the OAuth2 flow for a provider - -### Synopsis - -Initiate the OAuth2 flow for an external auth provider 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. - -``` -slackk external-auth add [flags] -``` - -### Examples - -``` -# Select a provider to initiate the OAuth2 flow for -$ slackk external-auth add - -# Initiate the OAuth2 flow for the provided provider -$ slackk external-auth add -p github -``` - -### Options - -``` - -h, --help help for add - -p, --provider string the external auth Provider Key to add a secret to -``` - -### 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 - -* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers - diff --git a/docs/reference/commands/slackk_external-auth_remove.md b/docs/reference/commands/slackk_external-auth_remove.md deleted file mode 100644 index 398036c2..00000000 --- a/docs/reference/commands/slackk_external-auth_remove.md +++ /dev/null @@ -1,60 +0,0 @@ -## slackk external-auth remove - -Remove the saved tokens for a provider - -### Synopsis - -Remove tokens saved to external authentication providers of a workflow app. - -Existing tokens are only removed from your app, but are not revoked or deleted! -Tokens must be invalidated using the provider's developer console or via APIs. - -This command is supported for apps deployed to Slack managed infrastructure but -other apps can attempt to run the command with the --force flag. - -``` -slackk external-auth remove [flags] -``` - -### Examples - -``` -# Remove a token from the selected provider -$ slackk external-auth remove - -# Remove a token from the specified provider -$ slackk external-auth remove -p github - -# Remove all tokens from the specified provider -$ slackk external-auth remove --all -p github - -# Remove all tokens from all providers -$ slackk external-auth remove --all -``` - -### Options - -``` - -A, --all remove tokens for all providers or the specified provider - -h, --help help for remove - -p, --provider string the external auth Provider Key to remove a token for -``` - -### 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 - -* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers - diff --git a/docs/reference/commands/slackk_external-auth_select-auth.md b/docs/reference/commands/slackk_external-auth_select-auth.md deleted file mode 100644 index d5d348c0..00000000 --- a/docs/reference/commands/slackk_external-auth_select-auth.md +++ /dev/null @@ -1,50 +0,0 @@ -## slackk external-auth select-auth - -Select developer authentication of a workflow - -### Synopsis - -Select the saved developer authentication to use when calling external APIs from -functions in 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. - -``` -slackk external-auth select-auth [flags] -``` - -### Examples - -``` -# Select the saved developer authentication in a workflow -$ slackk external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com -``` - -### Options - -``` - -E, --external-account string external account identifier for the provider - -h, --help help for select-auth - -p, --provider string provider of the developer account - -W, --workflow string workflow to set developer authentication for -``` - -### 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 - -* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers - diff --git a/docs/reference/commands/slackk_feedback.md b/docs/reference/commands/slackk_feedback.md deleted file mode 100644 index 9a388ac1..00000000 --- a/docs/reference/commands/slackk_feedback.md +++ /dev/null @@ -1,49 +0,0 @@ -## slackk feedback - -Share feedback about your experience or project - -### Synopsis - -Help us make the Slack Platform better with your feedback - -``` -slackk feedback [flags] -``` - -### Examples - -``` -# Choose to give feedback on part of the Slack Platform -$ slackk feedback -$ slackk feedback --name slack-cli # Give feedback on the Slack CLI -``` - -### Options - -``` - -h, --help help for feedback - --name string name of the feedback: - slack-cli - slack-platform - - --no-prompt run command without prompts -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_function.md b/docs/reference/commands/slackk_function.md deleted file mode 100644 index e9be7361..00000000 --- a/docs/reference/commands/slackk_function.md +++ /dev/null @@ -1,56 +0,0 @@ -## slackk function - -Manage the functions of an app - -### Synopsis - -Functions are pieces of logic that complete the puzzle of workflows in Workflow -Builder. Whatever that puzzle might be. - -Inspect and configure the custom functions included in an app with this command. -Functions can be added as a step in Workflow Builder and shared among teammates. - -Learn more about functions: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions"}} - -``` -slackk function [flags] -``` - -### Examples - -``` -# Select a function and choose distribution options -$ slackk function distribute - -# Distribute a function to everyone in a workspace -$ slackk function distribute --name callback_id --everyone - -# Lookup the distribution information for a function -$ slackk function distribute --info -``` - -### Options - -``` - -h, --help help for function -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk function access](slackk_function_access.md) - Adjust who can access functions published from an app - diff --git a/docs/reference/commands/slackk_function_access.md b/docs/reference/commands/slackk_function_access.md deleted file mode 100644 index 277aef9e..00000000 --- a/docs/reference/commands/slackk_function_access.md +++ /dev/null @@ -1,70 +0,0 @@ -## slackk function access - -Adjust who can access functions published from an app - -### Synopsis - -Adjust who can {{ToBold "access"}} functions published by an app when building a workflow in -Workflow Builder. - -New functions are granted access to {{ToBold "app collaborators"}} by default. This includes -both the {{ToBold "reader"}} and {{ToBold "owner"}} permissions. Access can also be {{ToBold "granted"}} or {{ToBold "revoked"}} to -specific {{ToBold "users"}} or {{ToBold "everyone"}} alongside the {{ToBold "app collaborators"}}. - -Workflows that include a function with limited access can still be invoked with -a trigger of the workflow. The {{ToBold "access"}} command applies to Workflow Builder access -only. - -``` -slackk function access [flags] -``` - -### Examples - -``` -# Select a function and choose access options -$ slackk function access - -# Share a function with everyone in a workspace -$ slackk function access --name callback_id --everyone - -# Revoke function access for multiple users -$ slackk function access --name callback_id --revoke \ - --users USLACKBOT,U012345678,U0RHJTSPQ3 - -# Lookup access information for a function -$ slackk function access --info -``` - -### Options - -``` - -A, --app-collaborators grant access to only fellow app collaborators - -E, --everyone grant access to everyone in installed workspaces - -F, --file string specify access permissions using a file - -G, --grant grant access to --users to use --name - -h, --help help for access - -I, --info check who has access to the function --name - -N, --name string the callback_id of a function in your app - -R, --revoke revoke access for --users to use --name - -U, --users string a comma-separated list of Slack user IDs -``` - -### 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 - -* [slackk function](slackk_function.md) - Manage the functions of an app - diff --git a/docs/reference/commands/slackk_init.md b/docs/reference/commands/slackk_init.md deleted file mode 100644 index 7124377b..00000000 --- a/docs/reference/commands/slackk_init.md +++ /dev/null @@ -1,62 +0,0 @@ -## slackk init - -Initialize a project to work with the Slack CLI - -### Synopsis - -Initializes a project to support the Slack CLI. - -Adds a .slack directory with the following files: -- project-name/.slack -- project-name/.slack/.gitignore -- project-name/.slack/config.json -- project-name/.slack/hooks.json - -Adds the Slack CLI hooks dependency to your project: -- Deno: Unsupported -- Node.js: Updates package.json -- Python: Updates requirements.txt - -Installs your project dependencies when supported: -- Deno: Supported -- Node.js: Supported -- Python: Unsupported - -Adds an existing app to your project (optional): -- Prompts to add an existing app from app settings -- Runs the command `slackk app link` - -``` -slackk init [flags] -``` - -### Examples - -``` -$ slackk init # Initialize a project -``` - -### Options - -``` - -h, --help help for init -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_install.md b/docs/reference/commands/slackk_install.md deleted file mode 100644 index 656dfba7..00000000 --- a/docs/reference/commands/slackk_install.md +++ /dev/null @@ -1,52 +0,0 @@ -## slackk install - -Install the app to a team - -### Synopsis - -Install the app to a team - -``` -slackk install [flags] -``` - -### Examples - -``` -# Install a production app to a team -$ slackk app install - -# Install a production app to a specific team -$ slackk app install --team T0123456 --environment deployed - -# Install a local dev app to a specific team -$ slackk app install --team T0123456 --environment local -``` - -### Options - -``` - -E, --environment string environment of app (local, deployed) - -h, --help help for install - --org-workspace-grant string grant access to a specific org workspace ID - (or 'all' for all workspaces in the org) -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_list.md b/docs/reference/commands/slackk_list.md deleted file mode 100644 index 3f6d8a1a..00000000 --- a/docs/reference/commands/slackk_list.md +++ /dev/null @@ -1,42 +0,0 @@ -## slackk list - -List all authorized accounts - -### Synopsis - -List all authorized accounts - -``` -slackk list [flags] -``` - -### Examples - -``` -$ slackk auth list # List all authorized accounts -``` - -### Options - -``` - -h, --help help for list -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_login.md b/docs/reference/commands/slackk_login.md deleted file mode 100644 index dc917414..00000000 --- a/docs/reference/commands/slackk_login.md +++ /dev/null @@ -1,55 +0,0 @@ -## slackk login - -Log in to a Slack account - -### Synopsis - -Log in to a Slack account in your team - -``` -slackk login [flags] -``` - -### Examples - -``` -# Login to a Slack account with prompts -$ slackk auth login - -# Login to a Slack account without prompts, this returns a ticket -$ slackk auth login --no-prompt - -# Complete login using ticket and challenge code -$ slackk auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... - -# Login with a user token -$ slackk auth login --token xoxp-... -``` - -### Options - -``` - --challenge string provide a challenge code for pre-authenticated login - -h, --help help for login - --no-prompt login without prompts using ticket and challenge code - --ticket string provide an auth ticket value - --token string provide a token for a pre-authenticated login -``` - -### 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 - -v, --verbose print debug logging and additional info -``` - -### SEE ALSO - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_logout.md b/docs/reference/commands/slackk_logout.md deleted file mode 100644 index 46ed3c88..00000000 --- a/docs/reference/commands/slackk_logout.md +++ /dev/null @@ -1,44 +0,0 @@ -## slackk logout - -Log out of a team - -### Synopsis - -Log out of a team, removing any local credentials - -``` -slackk logout [flags] -``` - -### Examples - -``` -$ slackk auth logout # Select a team to log out of -$ slackk auth logout --all # Log out of all team -``` - -### Options - -``` - -A, --all logout of all workspaces - -h, --help help for logout -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_manifest.md b/docs/reference/commands/slackk_manifest.md deleted file mode 100644 index 3d890afe..00000000 --- a/docs/reference/commands/slackk_manifest.md +++ /dev/null @@ -1,56 +0,0 @@ -## slackk manifest - -Print the app manifest of a project or app - -### Synopsis - -Get the manifest of an app using either the "remote" values on app settings -or from the "local" configurations. - -Subcommands unlock additional engagements and interactions with the manifest. - -The manifest on app settings represents the latest version of the manifest. - -Project configurations use the "get-manifest" hook from ".slack/hooks.json". - -``` -slackk manifest [flags] -``` - -### Examples - -``` -# Display the app manifest for the current project -$ slackk manifest info - -# Validate the app manifest generated by a project -$ slackk manifest validate -``` - -### Options - -``` - -h, --help help for manifest - --source string source of the app manifest ("local" or "remote") -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk manifest info](slackk_manifest_info.md) - Print the app manifest of a project or app -* [slackk manifest validate](slackk_manifest_validate.md) - Validate the app manifest generated by a project - diff --git a/docs/reference/commands/slackk_manifest_info.md b/docs/reference/commands/slackk_manifest_info.md deleted file mode 100644 index a1c2abfb..00000000 --- a/docs/reference/commands/slackk_manifest_info.md +++ /dev/null @@ -1,55 +0,0 @@ -## slackk manifest info - -Print the app manifest of a project or app - -### Synopsis - -Get the manifest of an app using either the "remote" values on app settings -or from the "local" configurations. - -The manifest on app settings represents the latest version of the manifest. - -Project configurations use the "get-manifest" hook from ".slack/hooks.json". - -``` -slackk manifest info [flags] -``` - -### Examples - -``` -# Print the app manifest from project configurations -$ slackk manifest info - -# Print the remote manifest of an app -$ slackk manifest info --app A0123456789 - -# Print the app manifest gathered from App Config -$ slackk manifest info --source remote -``` - -### Options - -``` - -h, --help help for info - --source string source of the app manifest ("local" or "remote") -``` - -### 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 - -* [slackk manifest](slackk_manifest.md) - Print the app manifest of a project or app - diff --git a/docs/reference/commands/slackk_manifest_validate.md b/docs/reference/commands/slackk_manifest_validate.md deleted file mode 100644 index 51ce34a8..00000000 --- a/docs/reference/commands/slackk_manifest_validate.md +++ /dev/null @@ -1,43 +0,0 @@ -## slackk manifest validate - -Validate the app manifest generated by a project - -### Synopsis - -Validate the app manifest generated from a valid project directory - -``` -slackk manifest validate [flags] -``` - -### Examples - -``` -# Validate the app manifest generated by a project -$ slackk manifest validate -``` - -### Options - -``` - -h, --help help for validate -``` - -### 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 - -* [slackk manifest](slackk_manifest.md) - Print the app manifest of a project or app - diff --git a/docs/reference/commands/slackk_platform.md b/docs/reference/commands/slackk_platform.md deleted file mode 100644 index 1897dab1..00000000 --- a/docs/reference/commands/slackk_platform.md +++ /dev/null @@ -1,47 +0,0 @@ -## slackk platform - -Deploy and run apps on the Slack Platform - -### Synopsis - -Deploy and run apps on the Slack Platform - -``` -slackk platform [flags] -``` - -### Examples - -``` -$ slackk run # Run an app locally in a workspace -$ slackk deploy --team T0123456 # Deploy to a specific team -$ slackk activity -t # Continuously poll for new activity logs -``` - -### Options - -``` - -h, --help help for platform -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk platform activity](slackk_platform_activity.md) - Display the app activity logs from the Slack Platform -* [slackk platform deploy](slackk_platform_deploy.md) - Deploy the app to the Slack Platform -* [slackk platform run](slackk_platform_run.md) - Start a local server to develop and run the app locally - diff --git a/docs/reference/commands/slackk_platform_activity.md b/docs/reference/commands/slackk_platform_activity.md deleted file mode 100644 index ba04ffad..00000000 --- a/docs/reference/commands/slackk_platform_activity.md +++ /dev/null @@ -1,60 +0,0 @@ -## slackk platform activity - -Display the app activity logs from the Slack Platform - -### Synopsis - -Display the app activity logs from the Slack Platform - -``` -slackk platform activity [flags] -``` - -### Examples - -``` -$ slackk platform activity # Display app activity logs for an app -$ slackk platform activity -t # Continuously poll for new activity logs -``` - -### Options - -``` - --component string component type to filter - --component-id string component id to filter - (either a function id or workflow id) - --event string event type to filter - -h, --help help for activity - --idle int time to poll without results before exiting - in minutes (default 5) - -i, --interval int polling interval in seconds (default 3) - --level string minimum log level to display (default "info") - (trace, debug, info, warn, error, fatal) - --limit int limit the amount of logs retrieved (default 100) - --max-date-created int maximum timestamp to filter - (unix timestamp in microseconds) - --min-date-created int minimum timestamp to filter - (unix timestamp in microseconds) - --source string source (slack or developer) to filter - -t, --tail continuously poll for new activity - --trace-id string trace id to filter -``` - -### 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 - -* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform - diff --git a/docs/reference/commands/slackk_platform_deploy.md b/docs/reference/commands/slackk_platform_deploy.md deleted file mode 100644 index 34fdf572..00000000 --- a/docs/reference/commands/slackk_platform_deploy.md +++ /dev/null @@ -1,47 +0,0 @@ -## slackk platform deploy - -Deploy the app to the Slack Platform - -### Synopsis - -Deploy the app to the Slack Platform - -``` -slackk platform deploy [flags] -``` - -### Examples - -``` -# Select the workspace to deploy to -$ slackk platform deploy -$ slackk platform deploy --team T0123456 # Deploy to a specific team -``` - -### Options - -``` - -h, --help help for deploy - --hide-triggers do not list triggers and skip trigger creation prompts - --org-workspace-grant string grant access to a specific org workspace ID - (or 'all' for all workspaces in the org) -``` - -### 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 - -* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform - diff --git a/docs/reference/commands/slackk_platform_run.md b/docs/reference/commands/slackk_platform_run.md deleted file mode 100644 index ab3b3551..00000000 --- a/docs/reference/commands/slackk_platform_run.md +++ /dev/null @@ -1,55 +0,0 @@ -## slackk platform run - -Start a local server to develop and run the app locally - -### Synopsis - -Start a local server to develop and run the app locally while watching for file changes - -``` -slackk platform run [flags] -``` - -### Examples - -``` -# Start a local development server -$ slackk platform run - -# Run a local development server with debug activity -$ slackk platform run --activity-level debug - -# Run a local development server with cleanup -$ slackk platform run --cleanup -``` - -### Options - -``` - --activity-level string activity level to display (default "info") - --cleanup uninstall the local app after exiting - -h, --help help for run - --hide-triggers do not list triggers and skip trigger creation prompts - --no-activity hide Slack Platform log activity - --org-workspace-grant string grant access to a specific org workspace ID - (or 'all' for all workspaces in the org) -``` - -### 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 - -* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform - diff --git a/docs/reference/commands/slackk_project.md b/docs/reference/commands/slackk_project.md deleted file mode 100644 index ab3d6150..00000000 --- a/docs/reference/commands/slackk_project.md +++ /dev/null @@ -1,58 +0,0 @@ -## slackk project - -Create, manage, and doctor a project - -### Synopsis - -Create, manage, and doctor a project and its configuration files. - -Get started by creating a new project using the {{ToBold "create"}} command. - -Initialize an existing project with CLI support using the {{ToBold "init"}} command. - -Check your project health and diagnose problems with the {{ToBold "doctor"}} command. - -``` -slackk project [flags] -``` - -### Examples - -``` -# Creates a new Slack project from an optional template -$ slackk project create - -# Initialize an existing project to work with the Slack CLI -$ slackk project init - -# Creates a new Slack project from the sample gallery -$ slackk project samples -``` - -### Options - -``` - -h, --help help for project -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk project create](slackk_project_create.md) - Create a new Slack project -* [slackk project init](slackk_project_init.md) - Initialize a project to work with the Slack CLI -* [slackk project samples](slackk_project_samples.md) - List available sample apps - diff --git a/docs/reference/commands/slackk_project_create.md b/docs/reference/commands/slackk_project_create.md deleted file mode 100644 index 454f59a6..00000000 --- a/docs/reference/commands/slackk_project_create.md +++ /dev/null @@ -1,48 +0,0 @@ -## slackk project create - -Create a new Slack project - -### Synopsis - -Create a new Slack project on your local machine from an optional template - -``` -slackk project create [name] [flags] -``` - -### Examples - -``` -# Create a new project from a template -$ slackk create my-project - -# Start a new project from a specific template -$ slackk create my-project -t slack-samples/deno-hello-world -``` - -### Options - -``` - -b, --branch string name of git branch to checkout - -h, --help help for create - -t, --template string template URL for your app -``` - -### 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 - -* [slackk project](slackk_project.md) - Create, manage, and doctor a project - diff --git a/docs/reference/commands/slackk_project_init.md b/docs/reference/commands/slackk_project_init.md deleted file mode 100644 index 302731c0..00000000 --- a/docs/reference/commands/slackk_project_init.md +++ /dev/null @@ -1,62 +0,0 @@ -## slackk project init - -Initialize a project to work with the Slack CLI - -### Synopsis - -Initializes a project to support the Slack CLI. - -Adds a .slack directory with the following files: -- project-name/.slack -- project-name/.slack/.gitignore -- project-name/.slack/config.json -- project-name/.slack/hooks.json - -Adds the Slack CLI hooks dependency to your project: -- Deno: Unsupported -- Node.js: Updates package.json -- Python: Updates requirements.txt - -Installs your project dependencies when supported: -- Deno: Supported -- Node.js: Supported -- Python: Unsupported - -Adds an existing app to your project (optional): -- Prompts to add an existing app from app settings -- Runs the command `slackk app link` - -``` -slackk project init [flags] -``` - -### Examples - -``` -$ slackk init # Initialize a project -``` - -### Options - -``` - -h, --help help for init -``` - -### 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 - -* [slackk project](slackk_project.md) - Create, manage, and doctor a project - diff --git a/docs/reference/commands/slackk_project_samples.md b/docs/reference/commands/slackk_project_samples.md deleted file mode 100644 index ce965883..00000000 --- a/docs/reference/commands/slackk_project_samples.md +++ /dev/null @@ -1,46 +0,0 @@ -## slackk project samples - -List available sample apps - -### Synopsis - -List and create an app from the available samples - -``` -slackk project samples [name] [flags] -``` - -### Examples - -``` -$ slackk samples my-project # Select a sample app to create -``` - -### Options - -``` - -b, --branch string name of git branch to checkout - -h, --help help for samples - --language string runtime for the app framework - ex: "deno", "node", "python" - -t, --template string template URL for your app -``` - -### 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 - -* [slackk project](slackk_project.md) - Create, manage, and doctor a project - diff --git a/docs/reference/commands/slackk_run.md b/docs/reference/commands/slackk_run.md deleted file mode 100644 index d323e80f..00000000 --- a/docs/reference/commands/slackk_run.md +++ /dev/null @@ -1,55 +0,0 @@ -## slackk run - -Start a local server to develop and run the app locally - -### Synopsis - -Start a local server to develop and run the app locally while watching for file changes - -``` -slackk run [flags] -``` - -### Examples - -``` -# Start a local development server -$ slackk platform run - -# Run a local development server with debug activity -$ slackk platform run --activity-level debug - -# Run a local development server with cleanup -$ slackk platform run --cleanup -``` - -### Options - -``` - --activity-level string activity level to display (default "info") - --cleanup uninstall the local app after exiting - -h, --help help for run - --hide-triggers do not list triggers and skip trigger creation prompts - --no-activity hide Slack Platform log activity - --org-workspace-grant string grant access to a specific org workspace ID - (or 'all' for all workspaces in the org) -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_samples.md b/docs/reference/commands/slackk_samples.md deleted file mode 100644 index 682c100b..00000000 --- a/docs/reference/commands/slackk_samples.md +++ /dev/null @@ -1,46 +0,0 @@ -## slackk samples - -List available sample apps - -### Synopsis - -List and create an app from the available samples - -``` -slackk samples [name] [flags] -``` - -### Examples - -``` -$ slackk samples my-project # Select a sample app to create -``` - -### Options - -``` - -b, --branch string name of git branch to checkout - -h, --help help for samples - --language string runtime for the app framework - ex: "deno", "node", "python" - -t, --template string template URL for your app -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_trigger.md b/docs/reference/commands/slackk_trigger.md deleted file mode 100644 index fb0e1c2d..00000000 --- a/docs/reference/commands/slackk_trigger.md +++ /dev/null @@ -1,62 +0,0 @@ -## slackk trigger - -List details of existing triggers - -### Synopsis - -List details of existing triggers - -``` -slackk trigger [flags] -``` - -### Examples - -``` -# Select who can run a trigger -$ slackk trigger access -$ slackk trigger create # Create a new trigger - -# Delete an existing trigger -$ slackk trigger delete --trigger-id Ft01234ABCD - -# Get details for a trigger -$ slackk trigger info --trigger-id Ft01234ABCD - -# List details for all existing triggers -$ slackk trigger list - -# Update a trigger definition -$ slackk trigger update --trigger-id Ft01234ABCD -``` - -### Options - -``` - -h, --help help for trigger -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool -* [slackk trigger access](slackk_trigger_access.md) - Manage who can use your triggers -* [slackk trigger create](slackk_trigger_create.md) - Create a trigger for a workflow -* [slackk trigger delete](slackk_trigger_delete.md) - Delete an existing trigger -* [slackk trigger info](slackk_trigger_info.md) - Get details for a specific trigger -* [slackk trigger list](slackk_trigger_list.md) - List details of existing triggers -* [slackk trigger update](slackk_trigger_update.md) - Updates an existing trigger - diff --git a/docs/reference/commands/slackk_trigger_access.md b/docs/reference/commands/slackk_trigger_access.md deleted file mode 100644 index 4927236c..00000000 --- a/docs/reference/commands/slackk_trigger_access.md +++ /dev/null @@ -1,65 +0,0 @@ -## slackk trigger access - -Manage who can use your triggers - -### Synopsis - -Manage who can use your triggers - -``` -slackk trigger access --trigger-id [flags] -``` - -### Examples - -``` -# Grant everyone access to run a trigger -$ slackk trigger access --trigger-id Ft01234ABCD --everyone - -# Grant certain channels access to run a trigger -$ slackk trigger access --trigger-id Ft01234ABCD --grant \ - --channels C012345678 - -# Revoke certain users access to run a trigger -$ slackk trigger access --trigger-id Ft01234ABCD --revoke \ - --users USLACKBOT,U012345678 -``` - -### Options - -``` - -A, --app-collaborators grant permission to only app collaborators - -C, --channels string a comma-separated list of Slack channel IDs - -E, --everyone grant permission to everyone in your workspace - -G, --grant grant permission to --users or --channels to - run the trigger --trigger-id - -h, --help help for access - --include-app-collaborators include app collaborators into named - entities to run the trigger --trigger-id - -I, --info check who has access to the trigger --trigger-id - -O, --organizations string a comma-separated list of Slack organization IDs - -R, --revoke revoke permission for --users or --channels to - run the trigger --trigger-id - -T, --trigger-id string the ID of the trigger - -U, --users string a comma-separated list of Slack user IDs - -W, --workspaces string a comma-separated list of Slack workspace IDs -``` - -### 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 - -* [slackk trigger](slackk_trigger.md) - List details of existing triggers - diff --git a/docs/reference/commands/slackk_trigger_create.md b/docs/reference/commands/slackk_trigger_create.md deleted file mode 100644 index c422d188..00000000 --- a/docs/reference/commands/slackk_trigger_create.md +++ /dev/null @@ -1,67 +0,0 @@ -## slackk trigger create - -Create a trigger for a workflow - -### Synopsis - -Create a trigger to start a workflow - -``` -slackk trigger create [flags] -``` - -### Examples - -``` -# Create a trigger by selecting an app and trigger definition -$ slackk trigger create - -# Create a trigger from a definition file -$ slackk trigger create --trigger-def "triggers/shortcut_trigger.ts" - -# Create a trigger for a workflow -$ slackk trigger create --workflow "#/workflows/my_workflow" -``` - -### Options - -``` - --description string the description of this trigger - -h, --help help for create - --interactivity when used with --workflow, adds a - "slack#/types/interactivity" parameter - to the trigger with the name specified - by --interactivity-name - --interactivity-name string when used with --interactivity, specifies - the name of the interactivity parameter - to use (default "interactivity") - --org-workspace-grant string grant access to a specific org workspace ID - (or 'all' for all workspaces in the org) - --title string the title of this trigger - (default "My Trigger") - --trigger-def string path to a JSON file containing the trigger - definition. Overrides other flags setting - trigger properties. - --workflow string a reference to the workflow to execute - formatted as: - "#/workflows/" -``` - -### 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 - -* [slackk trigger](slackk_trigger.md) - List details of existing triggers - diff --git a/docs/reference/commands/slackk_trigger_delete.md b/docs/reference/commands/slackk_trigger_delete.md deleted file mode 100644 index 20990ecc..00000000 --- a/docs/reference/commands/slackk_trigger_delete.md +++ /dev/null @@ -1,47 +0,0 @@ -## slackk trigger delete - -Delete an existing trigger - -### Synopsis - -Delete an existing trigger - -``` -slackk trigger delete --trigger-id [flags] -``` - -### Examples - -``` -# Delete a specific trigger in a selected workspace -$ slackk trigger delete --trigger-id Ft01234ABCD - -# Delete a specific trigger for an app -$ slackk trigger delete --trigger-id Ft01234ABCD --app A0123456 -``` - -### Options - -``` - -h, --help help for delete - --trigger-id string the ID of the trigger -``` - -### 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 - -* [slackk trigger](slackk_trigger.md) - List details of existing triggers - diff --git a/docs/reference/commands/slackk_trigger_info.md b/docs/reference/commands/slackk_trigger_info.md deleted file mode 100644 index c8a4cee3..00000000 --- a/docs/reference/commands/slackk_trigger_info.md +++ /dev/null @@ -1,47 +0,0 @@ -## slackk trigger info - -Get details for a specific trigger - -### Synopsis - -Get details for a specific trigger - -``` -slackk trigger info --trigger-id [flags] -``` - -### Examples - -``` -# Get details for a specific trigger in a selected workspace -$ slackk trigger info --trigger-id Ft01234ABCD - -# Get details for a specific trigger -$ slackk trigger info --trigger-id Ft01234ABCD --app A0123456 -``` - -### Options - -``` - -h, --help help for info - --trigger-id string the ID of the trigger -``` - -### 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 - -* [slackk trigger](slackk_trigger.md) - List details of existing triggers - diff --git a/docs/reference/commands/slackk_trigger_list.md b/docs/reference/commands/slackk_trigger_list.md deleted file mode 100644 index 8335a50b..00000000 --- a/docs/reference/commands/slackk_trigger_list.md +++ /dev/null @@ -1,48 +0,0 @@ -## slackk trigger list - -List details of existing triggers - -### Synopsis - -List details of existing triggers - -``` -slackk trigger list [flags] -``` - -### Examples - -``` -# List details for all existing triggers -$ slackk trigger list - -# List triggers for a specific app -$ slackk trigger list --team T0123456 --app local -``` - -### Options - -``` - -h, --help help for list - -L, --limit int Limit the number of triggers to show (default 4) - -T, --type string Only display triggers of the given type, can be one of 'all', 'shortcut', 'event', 'scheduled', 'webhook', and 'external' (default "all") -``` - -### 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 - -* [slackk trigger](slackk_trigger.md) - List details of existing triggers - diff --git a/docs/reference/commands/slackk_trigger_update.md b/docs/reference/commands/slackk_trigger_update.md deleted file mode 100644 index 2bdeb2cf..00000000 --- a/docs/reference/commands/slackk_trigger_update.md +++ /dev/null @@ -1,64 +0,0 @@ -## slackk trigger update - -Updates an existing trigger - -### Synopsis - -Updates an existing trigger with the provided definition. Only supports full replacement, no partial update. - -``` -slackk trigger update --trigger-id [flags] -``` - -### Examples - -``` -# Update a trigger definition with a selected file -$ slackk trigger update --trigger-id Ft01234ABCD - -# Update a trigger with a workflow id and title -$ slackk trigger update --trigger-id Ft01234ABCD \ - --workflow "#/workflows/my_workflow" --title "Updated trigger" -``` - -### Options - -``` - --description string the description of this trigger - -h, --help help for update - --interactivity when used with --workflow, adds a - "slack#/types/interactivity" parameter - to the trigger with the name specified - by --interactivity-name - --interactivity-name string when used with --interactivity, specifies - the name of the interactivity parameter - to use (default "interactivity") - --title string the title of this trigger - (default "My Trigger") - --trigger-def string path to a JSON file containing the trigger - definition. Overrides other flags setting - trigger properties. - --trigger-id string the ID of the trigger to update - --workflow string a reference to the workflow to execute - formatted as: - "#/workflows/" -``` - -### 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 - -* [slackk trigger](slackk_trigger.md) - List details of existing triggers - diff --git a/docs/reference/commands/slackk_uninstall.md b/docs/reference/commands/slackk_uninstall.md deleted file mode 100644 index e73f77cd..00000000 --- a/docs/reference/commands/slackk_uninstall.md +++ /dev/null @@ -1,42 +0,0 @@ -## slackk uninstall - -Uninstall the app from a team - -### Synopsis - -Uninstall the app from a team without deleting the app or its data - -``` -slackk uninstall [flags] -``` - -### Examples - -``` -$ slackk app uninstall # Uninstall an app from a team -``` - -### Options - -``` - -h, --help help for uninstall -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_upgrade.md b/docs/reference/commands/slackk_upgrade.md deleted file mode 100644 index 787d3fc4..00000000 --- a/docs/reference/commands/slackk_upgrade.md +++ /dev/null @@ -1,46 +0,0 @@ -## slackk upgrade - -Checks for available updates to the CLI or SDK - -### Synopsis - -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 {{LinkText "https://docs.slack.dev/changelog"}} - -``` -slackk upgrade [flags] -``` - -### Examples - -``` -$ slackk upgrade # Check for any available updates -``` - -### Options - -``` - -h, --help help for upgrade -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - diff --git a/docs/reference/commands/slackk_version.md b/docs/reference/commands/slackk_version.md deleted file mode 100644 index d84bcd7e..00000000 --- a/docs/reference/commands/slackk_version.md +++ /dev/null @@ -1,64 +0,0 @@ -## slackk version - -Print the version number - -### Synopsis - -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` - -``` -slackk version [flags] -``` - -### Examples - -``` -$ slackk version # Print version number using the command -$ slackk --version # Print version number using the flag -$ slackk --version --skip-update # Print version and skip update check -``` - -### Options - -``` - -h, --help help for version -``` - -### 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 - -* [slackk](slackk.md) - Slack command-line tool - From c4ea92e6a6f2ae9645c56d38019fc2de376fcb27 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Fri, 15 Aug 2025 13:45:35 -0700 Subject: [PATCH 4/4] isolating workflow --- docs/reference/commands/slack.md | 28 +++++------ docs/reference/commands/slack_activity.md | 22 ++++----- docs/reference/commands/slack_app.md | 30 ++++++------ docs/reference/commands/slack_app_delete.md | 28 +++++------ docs/reference/commands/slack_app_install.md | 31 ++++++------- docs/reference/commands/slack_app_link.md | 28 +++++------ docs/reference/commands/slack_app_list.md | 20 ++++---- docs/reference/commands/slack_app_settings.md | 28 +++++------ .../reference/commands/slack_app_uninstall.md | 20 ++++---- docs/reference/commands/slack_auth.md | 24 +++++----- docs/reference/commands/slack_auth_list.md | 20 ++++---- docs/reference/commands/slack_auth_login.md | 40 ++++++++-------- docs/reference/commands/slack_auth_logout.md | 22 ++++----- docs/reference/commands/slack_auth_revoke.md | 20 ++++---- docs/reference/commands/slack_auth_token.md | 34 +++++++------- docs/reference/commands/slack_collaborator.md | 28 +++++------ .../commands/slack_collaborator_add.md | 24 +++++----- .../commands/slack_collaborator_list.md | 20 ++++---- .../commands/slack_collaborator_remove.md | 24 +++++----- docs/reference/commands/slack_create.md | 28 +++++------ docs/reference/commands/slack_datastore.md | 46 +++++++++---------- .../commands/slack_datastore_bulk-delete.md | 28 +++++------ .../commands/slack_datastore_bulk-get.md | 28 +++++------ .../commands/slack_datastore_bulk-put.md | 28 +++++------ .../commands/slack_datastore_count.md | 28 +++++------ .../commands/slack_datastore_delete.md | 28 +++++------ .../reference/commands/slack_datastore_get.md | 28 +++++------ .../reference/commands/slack_datastore_put.md | 28 +++++------ .../commands/slack_datastore_query.md | 40 ++++++++-------- .../commands/slack_datastore_update.md | 28 +++++------ docs/reference/commands/slack_delete.md | 28 +++++------ docs/reference/commands/slack_deploy.md | 24 +++++----- docs/reference/commands/slack_doctor.md | 20 ++++---- docs/reference/commands/slack_env.md | 34 +++++++------- docs/reference/commands/slack_env_add.md | 30 ++++++------ docs/reference/commands/slack_env_list.md | 20 ++++---- docs/reference/commands/slack_env_remove.md | 24 +++++----- .../reference/commands/slack_external-auth.md | 42 ++++++++--------- .../slack_external-auth_add-secret.md | 28 +++++------ .../commands/slack_external-auth_add.md | 28 +++++------ .../commands/slack_external-auth_remove.md | 40 ++++++++-------- .../slack_external-auth_select-auth.md | 22 ++++----- docs/reference/commands/slack_feedback.md | 24 +++++----- docs/reference/commands/slack_function.md | 36 +++++++-------- .../commands/slack_function_access.md | 42 ++++++++--------- docs/reference/commands/slack_init.md | 20 ++++---- docs/reference/commands/slack_install.md | 31 ++++++------- docs/reference/commands/slack_list.md | 20 ++++---- docs/reference/commands/slack_login.md | 40 ++++++++-------- docs/reference/commands/slack_logout.md | 22 ++++----- docs/reference/commands/slack_manifest.md | 28 +++++------ .../reference/commands/slack_manifest_info.md | 34 +++++++------- .../commands/slack_manifest_validate.md | 22 ++++----- docs/reference/commands/slack_platform.md | 24 +++++----- .../commands/slack_platform_activity.md | 22 ++++----- .../commands/slack_platform_deploy.md | 24 +++++----- docs/reference/commands/slack_platform_run.md | 34 +++++++------- docs/reference/commands/slack_project.md | 34 +++++++------- .../commands/slack_project_create.md | 28 +++++------ docs/reference/commands/slack_project_init.md | 20 ++++---- .../commands/slack_project_samples.md | 24 +++++----- docs/reference/commands/slack_run.md | 34 +++++++------- docs/reference/commands/slack_samples.md | 24 +++++----- docs/reference/commands/slack_trigger.md | 44 +++++++++--------- .../commands/slack_trigger_access.md | 38 +++++++-------- .../commands/slack_trigger_create.md | 34 +++++++------- .../commands/slack_trigger_delete.md | 28 +++++------ docs/reference/commands/slack_trigger_info.md | 28 +++++------ docs/reference/commands/slack_trigger_list.md | 28 +++++------ .../commands/slack_trigger_update.md | 30 ++++++------ docs/reference/commands/slack_uninstall.md | 20 ++++---- docs/reference/commands/slack_upgrade.md | 20 ++++---- docs/reference/commands/slack_version.md | 24 +++++----- docs/reference/errors.md | 32 ++++++------- 74 files changed, 1031 insertions(+), 1051 deletions(-) diff --git a/docs/reference/commands/slack.md b/docs/reference/commands/slack.md index ca9e5dd4..1ecaee8d 100644 --- a/docs/reference/commands/slack.md +++ b/docs/reference/commands/slack.md @@ -2,17 +2,27 @@ Slack command-line tool -## Description +## Synopsis CLI to create, run, and deploy Slack apps -Get started by reading the docs: [https://docs.slack.dev/tools/slack-cli](https://docs.slack.dev/tools/slack-cli) +Get started by reading the docs: [https://docs.slack.dev/tools/slack-cli](https://docs.slack.dev/tools/slack-cli/) ``` slack [flags] ``` -## Flags +## Examples + +``` +$ slack login # Log in to your Slack account +$ 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 +``` + +## Options ``` -a, --app string use a specific app ID or environment @@ -27,17 +37,7 @@ slack [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack login # Log in to your Slack account -$ 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 -``` - -## See also +## SEE ALSO * [slack activity](slack_activity) - Display the app activity logs from the Slack Platform * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_activity.md b/docs/reference/commands/slack_activity.md index 397fec27..b46104f5 100644 --- a/docs/reference/commands/slack_activity.md +++ b/docs/reference/commands/slack_activity.md @@ -2,7 +2,7 @@ Display the app activity logs from the Slack Platform -## Description +## Synopsis Display the app activity logs from the Slack Platform @@ -10,7 +10,14 @@ Display the app activity logs from the Slack Platform slack activity [flags] ``` -## Flags +## Examples + +``` +$ slack platform activity # Display app activity logs for an app +$ slack platform activity -t # Continuously poll for new activity logs +``` + +## Options ``` --component string component type to filter @@ -33,7 +40,7 @@ slack activity [flags] --trace-id string trace id to filter ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,14 +54,7 @@ slack activity [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack platform activity # Display app activity logs for an app -$ slack platform activity -t # Continuously poll for new activity logs -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_app.md b/docs/reference/commands/slack_app.md index be817fa5..1083f672 100644 --- a/docs/reference/commands/slack_app.md +++ b/docs/reference/commands/slack_app.md @@ -2,7 +2,7 @@ Install, uninstall, and list teams with the app installed -## Description +## Synopsis Install, uninstall, and list teams with the app installed @@ -10,13 +10,24 @@ Install, uninstall, and list teams with the app installed slack app [flags] ``` -## Flags +## Examples + +``` +$ 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 ``` -h, --help help for app ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,18 +41,7 @@ slack app [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ 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 -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack app delete](slack_app_delete) - Delete the app diff --git a/docs/reference/commands/slack_app_delete.md b/docs/reference/commands/slack_app_delete.md index 31336532..1cc5986a 100644 --- a/docs/reference/commands/slack_app_delete.md +++ b/docs/reference/commands/slack_app_delete.md @@ -2,7 +2,7 @@ Delete the app -## Description +## Synopsis Uninstall the app from the team and permanently delete the app and all of its data @@ -10,13 +10,23 @@ Uninstall the app from the team and permanently delete the app and all of its da slack app delete [flags] ``` -## Flags +## Examples + +``` +# Delete an app and app info from a team +$ slack app delete + +# Delete a specific app from a team +$ slack app delete --team T0123456 --app local +``` + +## Options ``` -h, --help help for delete ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,17 +40,7 @@ slack app delete [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Delete an app and app info from a team -$ slack app delete - -# Delete a specific app from a team -$ slack app delete --team T0123456 --app local -``` - -## See also +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_install.md b/docs/reference/commands/slack_app_install.md index d8c7dbfc..e8d27536 100644 --- a/docs/reference/commands/slack_app_install.md +++ b/docs/reference/commands/slack_app_install.md @@ -2,7 +2,7 @@ Install the app to a team -## Description +## Synopsis Install the app to a team @@ -10,16 +10,24 @@ Install the app to a team slack app install [flags] ``` -## Flags +## Examples + +``` +$ slack app install # Install a production app to a team + +# Install a production app to a specific team +$ slack app install --team T0123456 +``` + +## Options ``` - -E, --environment string environment of app (local, deployed) -h, --help help for install --org-workspace-grant string grant access to a specific org workspace ID (or 'all' for all workspaces in the org) ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -33,20 +41,7 @@ slack app install [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Install a production app to a team -$ slack app install - -# Install a production app to a specific team -$ slack app install --team T0123456 --environment deployed - -# Install a local dev app to a specific team -$ slack app install --team T0123456 --environment local -``` - -## See also +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_link.md b/docs/reference/commands/slack_app_link.md index 0afc1b20..848059c4 100644 --- a/docs/reference/commands/slack_app_link.md +++ b/docs/reference/commands/slack_app_link.md @@ -2,7 +2,7 @@ Add an existing app to the project -## Description +## Synopsis Saves an existing app to a project to be available to other commands. @@ -19,14 +19,24 @@ Only one app can exist for each combination of Team ID and environment. slack app link [flags] ``` -## Flags +## Examples + +``` +# Add an existing app to a project +$ slack app link + +# Add a specific app without using prompts +$ slack app link --team T0123456789 --app A0123456789 --environment deployed +``` + +## Options ``` -E, --environment string environment to save existing app (local, deployed) -h, --help help for link ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -40,17 +50,7 @@ slack app link [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Add an existing app to a project -$ slack app link - -# Add a specific app without using prompts -$ slack app link --team T0123456789 --app A0123456789 --environment deployed -``` - -## See also +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_list.md b/docs/reference/commands/slack_app_list.md index d38b8f81..452d4ab2 100644 --- a/docs/reference/commands/slack_app_list.md +++ b/docs/reference/commands/slack_app_list.md @@ -2,7 +2,7 @@ List teams with the app installed -## Description +## Synopsis List all teams that have installed the app @@ -10,7 +10,13 @@ List all teams that have installed the app slack app list [flags] ``` -## Flags +## Examples + +``` +$ slack app list # List all teams with the app installed +``` + +## Options ``` --all-org-workspace-grants display all workspace grants for an app @@ -18,7 +24,7 @@ slack app list [flags] -h, --help help for list ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -32,13 +38,7 @@ slack app list [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack app list # List all teams with the app installed -``` - -## See also +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_settings.md b/docs/reference/commands/slack_app_settings.md index 7c2c5325..58895fab 100644 --- a/docs/reference/commands/slack_app_settings.md +++ b/docs/reference/commands/slack_app_settings.md @@ -2,7 +2,7 @@ Open app settings for configurations -## Description +## Synopsis Open app settings to configure an application in a web browser. @@ -15,13 +15,23 @@ This command does not support apps deployed to Run on Slack infrastructure. slack app settings [flags] ``` -## 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 ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -35,17 +45,7 @@ slack app settings [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Open app settings for a prompted app -$ slack app settings - -# Open app settings for a specific app -$ slack app settings --app A0123456789 -``` - -## See also +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_uninstall.md b/docs/reference/commands/slack_app_uninstall.md index 4977663d..dea27a0d 100644 --- a/docs/reference/commands/slack_app_uninstall.md +++ b/docs/reference/commands/slack_app_uninstall.md @@ -2,7 +2,7 @@ Uninstall the app from a team -## Description +## Synopsis Uninstall the app from a team without deleting the app or its data @@ -10,13 +10,19 @@ Uninstall the app from a team without deleting the app or its data slack app uninstall [flags] ``` -## Flags +## Examples + +``` +$ slack app uninstall # Uninstall an app from a team +``` + +## Options ``` -h, --help help for uninstall ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,13 +36,7 @@ slack app uninstall [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack app uninstall # Uninstall an app from a team -``` - -## See also +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_auth.md b/docs/reference/commands/slack_auth.md index 6f91b6ed..112c9fef 100644 --- a/docs/reference/commands/slack_auth.md +++ b/docs/reference/commands/slack_auth.md @@ -2,7 +2,7 @@ Add and remove local team authorizations -## Description +## Synopsis Add and remove local team authorizations @@ -10,13 +10,21 @@ Add and remove local team authorizations slack auth [flags] ``` -## Flags +## Examples + +``` +$ slack auth list # List all authorized accounts +$ slack auth login # Log in to a Slack account +$ slack auth logout # Log out of a team +``` + +## Options ``` -h, --help help for auth ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,15 +38,7 @@ slack auth [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack auth list # List all authorized accounts -$ slack auth login # Log in to a Slack account -$ slack auth logout # Log out of a team -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack auth list](slack_auth_list) - List all authorized accounts diff --git a/docs/reference/commands/slack_auth_list.md b/docs/reference/commands/slack_auth_list.md index 01837506..42f18c02 100644 --- a/docs/reference/commands/slack_auth_list.md +++ b/docs/reference/commands/slack_auth_list.md @@ -2,7 +2,7 @@ List all authorized accounts -## Description +## Synopsis List all authorized accounts @@ -10,13 +10,19 @@ List all authorized accounts slack auth list [flags] ``` -## Flags +## Examples + +``` +$ slack auth list # List all authorized accounts +``` + +## Options ``` -h, --help help for list ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,13 +36,7 @@ slack auth list [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack auth list # List all authorized accounts -``` - -## See also +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_login.md b/docs/reference/commands/slack_auth_login.md index b12fac2c..cfe277ce 100644 --- a/docs/reference/commands/slack_auth_login.md +++ b/docs/reference/commands/slack_auth_login.md @@ -2,7 +2,7 @@ Log in to a Slack account -## Description +## Synopsis Log in to a Slack account in your team @@ -10,7 +10,23 @@ Log in to a Slack account in your team slack auth login [flags] ``` -## Flags +## Examples + +``` +# Login to a Slack account with prompts +$ slack auth login + +# Login to a Slack account without prompts, this returns a ticket +$ slack auth login --no-prompt + +# Complete login using ticket and challenge code +$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... + +# Login with a user token +$ slack auth login --token xoxp-... +``` + +## Options ``` --challenge string provide a challenge code for pre-authenticated login @@ -20,7 +36,7 @@ slack auth login [flags] --token string provide a token for a pre-authenticated login ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -33,23 +49,7 @@ slack auth login [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Login to a Slack account with prompts -$ slack auth login - -# Login to a Slack account without prompts, this returns a ticket -$ slack auth login --no-prompt - -# Complete login using ticket and challenge code -$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... - -# Login with a user token -$ slack auth login --token xoxp-... -``` - -## See also +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_logout.md b/docs/reference/commands/slack_auth_logout.md index 92fa7292..c266d9a8 100644 --- a/docs/reference/commands/slack_auth_logout.md +++ b/docs/reference/commands/slack_auth_logout.md @@ -2,7 +2,7 @@ Log out of a team -## Description +## Synopsis Log out of a team, removing any local credentials @@ -10,14 +10,21 @@ Log out of a team, removing any local credentials slack auth logout [flags] ``` -## Flags +## Examples + +``` +$ slack auth logout # Select a team to log out of +$ slack auth logout --all # Log out of all team +``` + +## Options ``` -A, --all logout of all workspaces -h, --help help for logout ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -31,14 +38,7 @@ slack auth logout [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack auth logout # Select a team to log out of -$ slack auth logout --all # Log out of all team -``` - -## See also +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_revoke.md b/docs/reference/commands/slack_auth_revoke.md index efb228ae..5e630c0f 100644 --- a/docs/reference/commands/slack_auth_revoke.md +++ b/docs/reference/commands/slack_auth_revoke.md @@ -2,7 +2,7 @@ Revoke an authentication token -## Description +## Synopsis Revoke an authentication token @@ -10,13 +10,19 @@ Revoke an authentication token slack auth revoke [flags] ``` -## Flags +## Examples + +``` +$ slack auth revoke --token xoxp-1-4921830... # Revoke a service token +``` + +## Options ``` -h, --help help for revoke ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,13 +36,7 @@ slack auth revoke [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack auth revoke --token xoxp-1-4921830... # Revoke a service token -``` - -## See also +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_token.md b/docs/reference/commands/slack_auth_token.md index 32002814..ed4c00eb 100644 --- a/docs/reference/commands/slack_auth_token.md +++ b/docs/reference/commands/slack_auth_token.md @@ -2,7 +2,7 @@ Collect a service token -## Description +## Synopsis Log in to a Slack account in your team @@ -10,7 +10,20 @@ Log in to a Slack account in your team slack auth token [flags] ``` -## Flags +## Examples + +``` +# Create a service token with prompts +$ slack auth token + +# Gather a service token without prompts, this returns a ticket +$ slack auth token --no-prompt + +# Complete authentication using a ticket and challenge code +$ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... +``` + +## Options ``` --challenge string provide a challenge code for pre-authenticated login @@ -19,7 +32,7 @@ slack auth token [flags] --ticket string provide an auth ticket value ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -33,20 +46,7 @@ slack auth token [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Create a service token with prompts -$ slack auth token - -# Gather a service token without prompts, this returns a ticket -$ slack auth token --no-prompt - -# Complete authentication using a ticket and challenge code -$ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... -``` - -## See also +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_collaborator.md b/docs/reference/commands/slack_collaborator.md index 47428061..d7059428 100644 --- a/docs/reference/commands/slack_collaborator.md +++ b/docs/reference/commands/slack_collaborator.md @@ -2,7 +2,7 @@ Manage app collaborators -## Description +## Synopsis Manage app collaborators @@ -10,13 +10,23 @@ Manage app collaborators slack collaborator [flags] ``` -## Flags +## Examples + +``` +$ slack collaborator add bots@slack.com # Add a collaborator from email +$ slack collaborator list # List all of the collaborators + +# Remove a collaborator by user ID +$ slack collaborator remove USLACKBOT +``` + +## Options ``` -h, --help help for collaborator ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,17 +40,7 @@ slack collaborator [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack collaborator add bots@slack.com # Add a collaborator from email -$ slack collaborator list # List all of the collaborators - -# Remove a collaborator by user ID -$ slack collaborator remove USLACKBOT -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack collaborator add](slack_collaborator_add) - Add a new collaborator to the app diff --git a/docs/reference/commands/slack_collaborator_add.md b/docs/reference/commands/slack_collaborator_add.md index 82e4e6c1..b175ac0b 100644 --- a/docs/reference/commands/slack_collaborator_add.md +++ b/docs/reference/commands/slack_collaborator_add.md @@ -2,7 +2,7 @@ Add a new collaborator to the app -## Description +## Synopsis Add a collaborator to your app by Slack email address or user ID @@ -10,13 +10,21 @@ Add a collaborator to your app by Slack email address or user ID slack collaborator add [email|user_id] [flags] ``` -## Flags +## Examples + +``` +$ slack collaborator add # Add a collaborator via prompt +$ slack collaborator add bot@slack.com # Add a collaborator from email +$ slack collaborator add USLACKBOT # Add a collaborator by user ID +``` + +## Options ``` -h, --help help for add ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,15 +38,7 @@ slack collaborator add [email|user_id] [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack collaborator add # Add a collaborator via prompt -$ slack collaborator add bot@slack.com # Add a collaborator from email -$ slack collaborator add USLACKBOT # Add a collaborator by user ID -``` - -## See also +## SEE ALSO * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_collaborator_list.md b/docs/reference/commands/slack_collaborator_list.md index 283607be..d1282beb 100644 --- a/docs/reference/commands/slack_collaborator_list.md +++ b/docs/reference/commands/slack_collaborator_list.md @@ -2,7 +2,7 @@ List all collaborators of an app -## Description +## Synopsis List all collaborators of an app @@ -10,13 +10,19 @@ List all collaborators of an app slack collaborator list [flags] ``` -## Flags +## Examples + +``` +$ slack collaborator list # List all of the collaborators +``` + +## Options ``` -h, --help help for list ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,13 +36,7 @@ slack collaborator list [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack collaborator list # List all of the collaborators -``` - -## See also +## SEE ALSO * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_collaborator_remove.md b/docs/reference/commands/slack_collaborator_remove.md index 676daa4e..7aeeea9a 100644 --- a/docs/reference/commands/slack_collaborator_remove.md +++ b/docs/reference/commands/slack_collaborator_remove.md @@ -2,7 +2,7 @@ Remove a collaborator from an app -## Description +## Synopsis Remove a collaborator from an app by Slack email address or user ID @@ -10,13 +10,21 @@ Remove a collaborator from an app by Slack email address or user ID slack collaborator remove [email|user_id] [flags] ``` -## Flags +## Examples + +``` +$ slack collaborator remove # Remove collaborator on prompt +$ slack collaborator remove bot@slack.com # Remove collaborator by email +$ slack collaborator remove USLACKBOT # Remove collaborator using ID +``` + +## Options ``` -h, --help help for remove ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,15 +38,7 @@ slack collaborator remove [email|user_id] [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack collaborator remove # Remove collaborator on prompt -$ slack collaborator remove bot@slack.com # Remove collaborator by email -$ slack collaborator remove USLACKBOT # Remove collaborator using ID -``` - -## See also +## SEE ALSO * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_create.md b/docs/reference/commands/slack_create.md index f11205a0..a8b1add5 100644 --- a/docs/reference/commands/slack_create.md +++ b/docs/reference/commands/slack_create.md @@ -2,7 +2,7 @@ Create a new Slack project -## Description +## Synopsis Create a new Slack project on your local machine from an optional template @@ -10,7 +10,17 @@ Create a new Slack project on your local machine from an optional template slack create [name] [flags] ``` -## Flags +## Examples + +``` +# Create a new project from a template +$ slack create my-project + +# Start a new project from a specific template +$ slack create my-project -t slack-samples/deno-hello-world +``` + +## Options ``` -b, --branch string name of git branch to checkout @@ -18,7 +28,7 @@ slack create [name] [flags] -t, --template string template URL for your app ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -32,17 +42,7 @@ slack create [name] [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Create a new project from a template -$ slack create my-project - -# Start a new project from a specific template -$ slack create my-project -t slack-samples/deno-hello-world -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_datastore.md b/docs/reference/commands/slack_datastore.md index da6f1ae4..02c6bc19 100644 --- a/docs/reference/commands/slack_datastore.md +++ b/docs/reference/commands/slack_datastore.md @@ -2,39 +2,19 @@ Interact with an app's datastore -## Description +## Synopsis Interact with the items stored in an app's datastore. This command is supported for apps deployed to Slack managed infrastructure but other apps can attempt to run the command with the --force flag. -Discover the datastores: [https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores](https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores) +Discover the datastores: [https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores](https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores/) ``` slack datastore [flags] ``` -## Flags - -``` - -h, --help help for datastore -``` - -## 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 ``` @@ -66,7 +46,27 @@ $ slack datastore query --datastore tasks '{"expression": "#status = :status", " $ slack datastore count --datastore tasks ``` -## See also +## Options + +``` + -h, --help help for datastore +``` + +## 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](slack) - Slack command-line tool * [slack datastore bulk-delete](slack_datastore_bulk-delete) - Delete multiple items from a datastore diff --git a/docs/reference/commands/slack_datastore_bulk-delete.md b/docs/reference/commands/slack_datastore_bulk-delete.md index b7dc6d92..b8c6bde5 100644 --- a/docs/reference/commands/slack_datastore_bulk-delete.md +++ b/docs/reference/commands/slack_datastore_bulk-delete.md @@ -2,7 +2,7 @@ Delete multiple items from a datastore -## Description +## Synopsis Delete multiple items from a datastore. @@ -13,7 +13,17 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-delete [flags] ``` -## Flags +## Examples + +``` +# Delete two items from the datastore +$ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' + +# Delete two items from the datastore with an expression +$ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -22,7 +32,7 @@ slack datastore bulk-delete [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,17 +46,7 @@ slack datastore bulk-delete [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Delete two items from the datastore -$ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' - -# Delete two items from the datastore with an expression -$ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_bulk-get.md b/docs/reference/commands/slack_datastore_bulk-get.md index 1aee8c55..f6406341 100644 --- a/docs/reference/commands/slack_datastore_bulk-get.md +++ b/docs/reference/commands/slack_datastore_bulk-get.md @@ -2,7 +2,7 @@ Get multiple items from a datastore -## Description +## Synopsis Get multiple items from a datastore. @@ -13,7 +13,17 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-get [flags] ``` -## Flags +## Examples + +``` +# Get two items from datastore +$ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' + +# Get two items from datastore with an expression +$ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -23,7 +33,7 @@ slack datastore bulk-get [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,17 +47,7 @@ slack datastore bulk-get [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Get two items from datastore -$ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' - -# Get two items from datastore with an expression -$ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_bulk-put.md b/docs/reference/commands/slack_datastore_bulk-put.md index da6bb7f4..3c857609 100644 --- a/docs/reference/commands/slack_datastore_bulk-put.md +++ b/docs/reference/commands/slack_datastore_bulk-put.md @@ -2,7 +2,7 @@ Create or replace a list of items in a datastore -## Description +## Synopsis Create or replace a list of items in a datastore. @@ -13,7 +13,17 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-put [flags] ``` -## Flags +## Examples + +``` +# Create or replace two new entries in the datastore +$ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' + +# Create or replace two new entries in the datastore with an expression +$ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -23,7 +33,7 @@ slack datastore bulk-put [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,17 +47,7 @@ slack datastore bulk-put [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Create or replace two new entries in the datastore -$ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' - -# Create or replace two new entries in the datastore with an expression -$ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_count.md b/docs/reference/commands/slack_datastore_count.md index 4ed1e473..f2528300 100644 --- a/docs/reference/commands/slack_datastore_count.md +++ b/docs/reference/commands/slack_datastore_count.md @@ -2,7 +2,7 @@ Count the number of items in a datastore -## Description +## Synopsis Count the number of items in a datastore that match a query expression or just all of the items in the datastore. @@ -14,7 +14,17 @@ other apps can attempt to run the command with the --force flag. slack datastore count [expression] [flags] ``` -## Flags +## Examples + +``` +# Count all items in a datastore +$ slack datastore count --datastore tasks + +# Count number of items in datastore that match a query +$ slack datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -23,7 +33,7 @@ slack datastore count [expression] [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,17 +47,7 @@ slack datastore count [expression] [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Count all items in a datastore -$ slack datastore count --datastore tasks - -# Count number of items in datastore that match a query -$ slack datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_delete.md b/docs/reference/commands/slack_datastore_delete.md index 1eb684cf..34a66e0d 100644 --- a/docs/reference/commands/slack_datastore_delete.md +++ b/docs/reference/commands/slack_datastore_delete.md @@ -2,7 +2,7 @@ Delete an item from a datastore -## Description +## Synopsis Delete an item from a datastore. @@ -13,7 +13,17 @@ other apps can attempt to run the command with the --force flag. slack datastore delete [flags] ``` -## Flags +## Examples + +``` +# Remove an item from the datastore +$ slack datastore delete --datastore tasks '{"id": "42"}' + +# Remove an item from the datastore with an expression +$ slack datastore delete '{"datastore": "tasks", "id": "42"}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -22,7 +32,7 @@ slack datastore delete [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,17 +46,7 @@ slack datastore delete [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Remove an item from the datastore -$ slack datastore delete --datastore tasks '{"id": "42"}' - -# Remove an item from the datastore with an expression -$ slack datastore delete '{"datastore": "tasks", "id": "42"}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_get.md b/docs/reference/commands/slack_datastore_get.md index b73c8de4..f79b8e5d 100644 --- a/docs/reference/commands/slack_datastore_get.md +++ b/docs/reference/commands/slack_datastore_get.md @@ -2,7 +2,7 @@ Get an item from a datastore -## Description +## Synopsis Get an item from a datastore. @@ -13,7 +13,17 @@ other apps can attempt to run the command with the --force flag. slack datastore get [flags] ``` -## Flags +## Examples + +``` +# Get an item from the datastore +$ slack datastore get --datastore tasks '{"id": "42"}' + +# Get an item from the datastore with an expression +$ slack datastore get '{"datastore": "tasks", "id": "42"}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -23,7 +33,7 @@ slack datastore get [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,17 +47,7 @@ slack datastore get [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Get an item from the datastore -$ slack datastore get --datastore tasks '{"id": "42"}' - -# Get an item from the datastore with an expression -$ slack datastore get '{"datastore": "tasks", "id": "42"}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_put.md b/docs/reference/commands/slack_datastore_put.md index 97544089..ddda038e 100644 --- a/docs/reference/commands/slack_datastore_put.md +++ b/docs/reference/commands/slack_datastore_put.md @@ -2,7 +2,7 @@ Create or replace an item in a datastore -## Description +## Synopsis Create or replace an item in a datastore. @@ -13,7 +13,17 @@ other apps can attempt to run the command with the --force flag. slack datastore put [flags] ``` -## Flags +## Examples + +``` +# Add a new entry to the datastore +$ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Add a new entry to the datastore with an expression +$ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -22,7 +32,7 @@ slack datastore put [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,17 +46,7 @@ slack datastore put [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Add a new entry to the datastore -$ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Add a new entry to the datastore with an expression -$ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_query.md b/docs/reference/commands/slack_datastore_query.md index c8e57039..8ef5d003 100644 --- a/docs/reference/commands/slack_datastore_query.md +++ b/docs/reference/commands/slack_datastore_query.md @@ -2,7 +2,7 @@ Query a datastore for items -## Description +## Synopsis Query a datastore for items. @@ -13,7 +13,23 @@ other apps can attempt to run the command with the --force flag. slack datastore query [flags] ``` -## Flags +## Examples + +``` +# Collect a limited set of items from the datastore +$ slack datastore query --datastore tasks '{"limit": 8}' --output json + +# Collect items from the datastore starting at a cursor +$ slack datastore query --datastore tasks '{"cursor": "eyJfX2NWaV..."}' + +# Query the datastore for specific items +$ slack datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' + +# Query the datastore for specific items with only an expression +$ slack datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -24,7 +40,7 @@ slack datastore query [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,23 +54,7 @@ slack datastore query [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Collect a limited set of items from the datastore -$ slack datastore query --datastore tasks '{"limit": 8}' --output json - -# Collect items from the datastore starting at a cursor -$ slack datastore query --datastore tasks '{"cursor": "eyJfX2NWaV..."}' - -# Query the datastore for specific items -$ slack datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' - -# Query the datastore for specific items with only an expression -$ slack datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_update.md b/docs/reference/commands/slack_datastore_update.md index 77fb20fa..e725beb9 100644 --- a/docs/reference/commands/slack_datastore_update.md +++ b/docs/reference/commands/slack_datastore_update.md @@ -2,7 +2,7 @@ Create or update an item in a datastore -## Description +## Synopsis Create or update an item in a datastore. @@ -13,7 +13,17 @@ other apps can attempt to run the command with the --force flag. slack datastore update [flags] ``` -## Flags +## Examples + +``` +# Update the entry in the datastore +$ slack datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' + +# Update the entry in the datastore with an expression +$ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' +``` + +## Options ``` --datastore string the datastore used to store items @@ -22,7 +32,7 @@ slack datastore update [flags] --unstable kick the tires of experimental features ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,17 +46,7 @@ slack datastore update [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Update the entry in the datastore -$ slack datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}' - -# Update the entry in the datastore with an expression -$ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' -``` - -## See also +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_delete.md b/docs/reference/commands/slack_delete.md index 8dcc2587..675f67fb 100644 --- a/docs/reference/commands/slack_delete.md +++ b/docs/reference/commands/slack_delete.md @@ -2,7 +2,7 @@ Delete the app -## Description +## Synopsis Uninstall the app from the team and permanently delete the app and all of its data @@ -10,13 +10,23 @@ Uninstall the app from the team and permanently delete the app and all of its da slack delete [flags] ``` -## Flags +## Examples + +``` +# Delete an app and app info from a team +$ slack app delete + +# Delete a specific app from a team +$ slack app delete --team T0123456 --app local +``` + +## Options ``` -h, --help help for delete ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,17 +40,7 @@ slack delete [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Delete an app and app info from a team -$ slack app delete - -# Delete a specific app from a team -$ slack app delete --team T0123456 --app local -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_deploy.md b/docs/reference/commands/slack_deploy.md index 83d7d541..e705c84d 100644 --- a/docs/reference/commands/slack_deploy.md +++ b/docs/reference/commands/slack_deploy.md @@ -2,7 +2,7 @@ Deploy the app to the Slack Platform -## Description +## Synopsis Deploy the app to the Slack Platform @@ -10,7 +10,15 @@ Deploy the app to the Slack Platform slack deploy [flags] ``` -## Flags +## Examples + +``` +# Select the workspace to deploy to +$ slack platform deploy +$ slack platform deploy --team T0123456 # Deploy to a specific team +``` + +## Options ``` -h, --help help for deploy @@ -19,7 +27,7 @@ slack deploy [flags] (or 'all' for all workspaces in the org) ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -33,15 +41,7 @@ slack deploy [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Select the workspace to deploy to -$ slack platform deploy -$ slack platform deploy --team T0123456 # Deploy to a specific team -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_doctor.md b/docs/reference/commands/slack_doctor.md index 643e284e..c1fa0672 100644 --- a/docs/reference/commands/slack_doctor.md +++ b/docs/reference/commands/slack_doctor.md @@ -2,7 +2,7 @@ Check and report on system and app information -## Description +## Synopsis Check and report on relevant system (and sometimes app) dependencies @@ -19,13 +19,19 @@ Unfortunately, the doctor command cannot heal all problems slack doctor [flags] ``` -## Flags +## Examples + +``` +$ slack doctor # Create a status report of system dependencies +``` + +## Options ``` -h, --help help for doctor ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -39,13 +45,7 @@ slack doctor [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack doctor # Create a status report of system dependencies -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_env.md b/docs/reference/commands/slack_env.md index 68956751..84e7b56f 100644 --- a/docs/reference/commands/slack_env.md +++ b/docs/reference/commands/slack_env.md @@ -2,7 +2,7 @@ Add, remove, or list environment variables -## Description +## Synopsis Add, remove, or list environment variables for apps deployed to Slack managed infrastructure. @@ -10,19 +10,31 @@ 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: [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) +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/) ``` slack env [flags] ``` -## Flags +## Examples + +``` +$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable + +# List all environment variables +$ slack env list + +# Remove an environment variable +$ slack env remove MAGIC_PASSWORD +``` + +## Options ``` -h, --help help for env ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,19 +48,7 @@ slack env [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable - -# List all environment variables -$ slack env list - -# Remove an environment variable -$ slack env remove MAGIC_PASSWORD -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack env add](slack_env_add) - Add an environment variable to the app diff --git a/docs/reference/commands/slack_env_add.md b/docs/reference/commands/slack_env_add.md index a9a058cb..207b7a05 100644 --- a/docs/reference/commands/slack_env_add.md +++ b/docs/reference/commands/slack_env_add.md @@ -2,7 +2,7 @@ Add an environment variable to the app -## Description +## Synopsis Add an environment variable to an app deployed to Slack managed infrastructure. @@ -15,14 +15,25 @@ other apps can attempt to run the command with the --force flag. slack env add [flags] ``` -## Flags +## Examples + +``` +# Prompt for an environment variable +$ slack env add +$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable + +# Prompt for an environment variable value +$ slack env add SECRET_PASSWORD +``` + +## Options ``` -h, --help help for add --value string set the environment variable value ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,18 +47,7 @@ slack env add [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Prompt for an environment variable -$ slack env add -$ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable - -# Prompt for an environment variable value -$ slack env add SECRET_PASSWORD -``` - -## See also +## SEE ALSO * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_env_list.md b/docs/reference/commands/slack_env_list.md index 40aed2a9..eb26caf2 100644 --- a/docs/reference/commands/slack_env_list.md +++ b/docs/reference/commands/slack_env_list.md @@ -2,7 +2,7 @@ List all environment variables for the app -## Description +## Synopsis List all of the environment variables of an app deployed to Slack managed infrastructure. @@ -14,13 +14,19 @@ other apps can attempt to run the command with the --force flag. slack env list [flags] ``` -## Flags +## Examples + +``` +$ slack env list # List all environment variables +``` + +## Options ``` -h, --help help for list ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -34,13 +40,7 @@ slack env list [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack env list # List all environment variables -``` - -## See also +## SEE ALSO * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_env_remove.md b/docs/reference/commands/slack_env_remove.md index d8d68e55..b81f4e30 100644 --- a/docs/reference/commands/slack_env_remove.md +++ b/docs/reference/commands/slack_env_remove.md @@ -2,7 +2,7 @@ Remove an environment variable from the app -## Description +## Synopsis Remove an environment variable from an app deployed to Slack managed infrastructure. @@ -16,14 +16,22 @@ other apps can attempt to run the command with the --force flag. slack env remove [flags] ``` -## Flags +## Examples + +``` +# Select an environment variable to remove +$ slack env remove +$ slack env remove MAGIC_PASSWORD # Remove an environment variable +``` + +## Options ``` -h, --help help for remove --name string choose the environment variable name ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,15 +45,7 @@ slack env remove [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Select an environment variable to remove -$ slack env remove -$ slack env remove MAGIC_PASSWORD # Remove an environment variable -``` - -## See also +## SEE ALSO * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_external-auth.md b/docs/reference/commands/slack_external-auth.md index bc9f9c71..8efa6658 100644 --- a/docs/reference/commands/slack_external-auth.md +++ b/docs/reference/commands/slack_external-auth.md @@ -2,26 +2,42 @@ Adjust settings of external authentication providers -## Description +## Synopsis 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: [https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication](https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication) +Explore providers: [https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication/](https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication/) ``` slack external-auth [flags] ``` -## Flags +## Examples + +``` +# Initiate OAuth2 flow for a selected provider +$ slack external-auth add + +# Set client secret for an app and provider +$ slack external-auth add-secret + +# Remove authorization for a specific provider +$ slack external-auth remove + +# Select authorization for a specific provider in a workflow +$ slack external-auth select-auth +``` + +## Options ``` -h, --help help for external-auth ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -35,23 +51,7 @@ slack external-auth [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Initiate OAuth2 flow for a selected provider -$ slack external-auth add - -# Set client secret for an app and provider -$ slack external-auth add-secret - -# Remove authorization for a specific provider -$ slack external-auth remove - -# Select authorization for a specific provider in a workflow -$ slack external-auth select-auth -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack external-auth add](slack_external-auth_add) - Initiate the OAuth2 flow for a provider diff --git a/docs/reference/commands/slack_external-auth_add-secret.md b/docs/reference/commands/slack_external-auth_add-secret.md index b178e2ec..14901281 100644 --- a/docs/reference/commands/slack_external-auth_add-secret.md +++ b/docs/reference/commands/slack_external-auth_add-secret.md @@ -2,7 +2,7 @@ Add the client secret for a provider -## Description +## Synopsis Add the client secret for an external provider of a workflow app. @@ -15,7 +15,17 @@ other apps can attempt to run the command with the --force flag. slack external-auth add-secret [flags] ``` -## Flags +## Examples + +``` +# Input the client secret for an app and provider +$ slack external-auth add-secret + +# Set the client secret for an app and provider +$ slack external-auth add-secret -p github -x ghp_token +``` + +## Options ``` -h, --help help for add-secret @@ -23,7 +33,7 @@ slack external-auth add-secret [flags] -x, --secret string external auth client secret for the provider ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,17 +47,7 @@ slack external-auth add-secret [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Input the client secret for an app and provider -$ slack external-auth add-secret - -# Set the client secret for an app and provider -$ slack external-auth add-secret -p github -x ghp_token -``` - -## See also +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_add.md b/docs/reference/commands/slack_external-auth_add.md index 058ecfb9..5f784bdf 100644 --- a/docs/reference/commands/slack_external-auth_add.md +++ b/docs/reference/commands/slack_external-auth_add.md @@ -2,7 +2,7 @@ Initiate the OAuth2 flow for a provider -## Description +## Synopsis Initiate the OAuth2 flow for an external auth provider of a workflow app. @@ -13,14 +13,24 @@ other apps can attempt to run the command with the --force flag. slack external-auth add [flags] ``` -## Flags +## Examples + +``` +# Select a provider to initiate the OAuth2 flow for +$ slack external-auth add + +# Initiate the OAuth2 flow for the provided provider +$ slack external-auth add -p github +``` + +## Options ``` -h, --help help for add -p, --provider string the external auth Provider Key to add a secret to ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -34,17 +44,7 @@ slack external-auth add [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Select a provider to initiate the OAuth2 flow for -$ slack external-auth add - -# Initiate the OAuth2 flow for the provided provider -$ slack external-auth add -p github -``` - -## See also +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_remove.md b/docs/reference/commands/slack_external-auth_remove.md index 1548544d..32f688a1 100644 --- a/docs/reference/commands/slack_external-auth_remove.md +++ b/docs/reference/commands/slack_external-auth_remove.md @@ -2,7 +2,7 @@ Remove the saved tokens for a provider -## Description +## Synopsis Remove tokens saved to external authentication providers of a workflow app. @@ -16,7 +16,23 @@ other apps can attempt to run the command with the --force flag. slack external-auth remove [flags] ``` -## Flags +## Examples + +``` +# Remove a token from the selected provider +$ slack external-auth remove + +# Remove a token from the specified provider +$ slack external-auth remove -p github + +# Remove all tokens from the specified provider +$ slack external-auth remove --all -p github + +# Remove all tokens from all providers +$ slack external-auth remove --all +``` + +## Options ``` -A, --all remove tokens for all providers or the specified provider @@ -24,7 +40,7 @@ slack external-auth remove [flags] -p, --provider string the external auth Provider Key to remove a token for ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,23 +54,7 @@ slack external-auth remove [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Remove a token from the selected provider -$ slack external-auth remove - -# Remove a token from the specified provider -$ slack external-auth remove -p github - -# Remove all tokens from the specified provider -$ slack external-auth remove --all -p github - -# Remove all tokens from all providers -$ slack external-auth remove --all -``` - -## See also +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_select-auth.md b/docs/reference/commands/slack_external-auth_select-auth.md index 682b8cad..daaf56ff 100644 --- a/docs/reference/commands/slack_external-auth_select-auth.md +++ b/docs/reference/commands/slack_external-auth_select-auth.md @@ -2,7 +2,7 @@ Select developer authentication of a workflow -## Description +## Synopsis Select the saved developer authentication to use when calling external APIs from functions in a workflow app. @@ -14,7 +14,14 @@ other apps can attempt to run the command with the --force flag. slack external-auth select-auth [flags] ``` -## Flags +## Examples + +``` +# Select the saved developer authentication in a workflow +$ slack external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com +``` + +## Options ``` -E, --external-account string external account identifier for the provider @@ -23,7 +30,7 @@ slack external-auth select-auth [flags] -W, --workflow string workflow to set developer authentication for ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,14 +44,7 @@ slack external-auth select-auth [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Select the saved developer authentication in a workflow -$ slack external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com -``` - -## See also +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_feedback.md b/docs/reference/commands/slack_feedback.md index 9c541c1c..3ffd6730 100644 --- a/docs/reference/commands/slack_feedback.md +++ b/docs/reference/commands/slack_feedback.md @@ -2,7 +2,7 @@ Share feedback about your experience or project -## Description +## Synopsis Help us make the Slack Platform better with your feedback @@ -10,7 +10,15 @@ Help us make the Slack Platform better with your feedback slack feedback [flags] ``` -## 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 ``` -h, --help help for feedback @@ -21,7 +29,7 @@ slack feedback [flags] --no-prompt run command without prompts ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -35,15 +43,7 @@ slack feedback [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Choose to give feedback on part of the Slack Platform -$ slack feedback -$ slack feedback --name slack-cli # Give feedback on the Slack CLI -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_function.md b/docs/reference/commands/slack_function.md index bfef53ce..8d8b76d3 100644 --- a/docs/reference/commands/slack_function.md +++ b/docs/reference/commands/slack_function.md @@ -2,7 +2,7 @@ Manage the functions of an app -## Description +## Synopsis Functions are pieces of logic that complete the puzzle of workflows in Workflow Builder. Whatever that puzzle might be. @@ -10,19 +10,32 @@ Builder. Whatever that puzzle might be. Inspect and configure the custom functions included in an app with this command. Functions can be added as a step in Workflow Builder and shared among teammates. -Learn more about functions: [https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions](https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions) +Learn more about functions: [https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions](https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions/) ``` slack function [flags] ``` -## Flags +## Examples + +``` +# Select a function and choose distribution options +$ slack function distribute + +# Distribute a function to everyone in a workspace +$ slack function distribute --name callback_id --everyone + +# Lookup the distribution information for a function +$ slack function distribute --info +``` + +## Options ``` -h, --help help for function ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,20 +49,7 @@ slack function [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Select a function and choose distribution options -$ slack function distribute - -# Distribute a function to everyone in a workspace -$ slack function distribute --name callback_id --everyone - -# Lookup the distribution information for a function -$ slack function distribute --info -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack function access](slack_function_access) - Adjust who can access functions published from an app diff --git a/docs/reference/commands/slack_function_access.md b/docs/reference/commands/slack_function_access.md index 823ef35e..cf307b95 100644 --- a/docs/reference/commands/slack_function_access.md +++ b/docs/reference/commands/slack_function_access.md @@ -2,7 +2,7 @@ Adjust who can access functions published from an app -## Description +## Synopsis Adjust who can **access** functions published by an app when building a workflow in Workflow Builder. @@ -19,7 +19,24 @@ only. slack function access [flags] ``` -## Flags +## Examples + +``` +# Select a function and choose access options +$ slack function access + +# Share a function with everyone in a workspace +$ slack function access --name callback_id --everyone + +# Revoke function access for multiple users +$ slack function access --name callback_id --revoke \ + --users USLACKBOT,U012345678,U0RHJTSPQ3 + +# Lookup access information for a function +$ slack function access --info +``` + +## Options ``` -A, --app-collaborators grant access to only fellow app collaborators @@ -33,7 +50,7 @@ slack function access [flags] -U, --users string a comma-separated list of Slack user IDs ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,24 +64,7 @@ slack function access [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Select a function and choose access options -$ slack function access - -# Share a function with everyone in a workspace -$ slack function access --name callback_id --everyone - -# Revoke function access for multiple users -$ slack function access --name callback_id --revoke \ - --users USLACKBOT,U012345678,U0RHJTSPQ3 - -# Lookup access information for a function -$ slack function access --info -``` - -## See also +## SEE ALSO * [slack function](slack_function) - Manage the functions of an app diff --git a/docs/reference/commands/slack_init.md b/docs/reference/commands/slack_init.md index ac85be37..4e60977f 100644 --- a/docs/reference/commands/slack_init.md +++ b/docs/reference/commands/slack_init.md @@ -2,7 +2,7 @@ Initialize a project to work with the Slack CLI -## Description +## Synopsis Initializes a project to support the Slack CLI. @@ -30,13 +30,19 @@ Adds an existing app to your project (optional): slack init [flags] ``` -## Flags +## Examples + +``` +$ slack init # Initialize a project +``` + +## Options ``` -h, --help help for init ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -50,13 +56,7 @@ slack init [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack init # Initialize a project -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_install.md b/docs/reference/commands/slack_install.md index be50b5dd..8bbe330b 100644 --- a/docs/reference/commands/slack_install.md +++ b/docs/reference/commands/slack_install.md @@ -2,7 +2,7 @@ Install the app to a team -## Description +## Synopsis Install the app to a team @@ -10,16 +10,24 @@ Install the app to a team slack install [flags] ``` -## Flags +## Examples + +``` +$ slack app install # Install a production app to a team + +# Install a production app to a specific team +$ slack app install --team T0123456 +``` + +## Options ``` - -E, --environment string environment of app (local, deployed) -h, --help help for install --org-workspace-grant string grant access to a specific org workspace ID (or 'all' for all workspaces in the org) ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -33,20 +41,7 @@ slack install [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Install a production app to a team -$ slack app install - -# Install a production app to a specific team -$ slack app install --team T0123456 --environment deployed - -# Install a local dev app to a specific team -$ slack app install --team T0123456 --environment local -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_list.md b/docs/reference/commands/slack_list.md index a6a3b307..c949ea10 100644 --- a/docs/reference/commands/slack_list.md +++ b/docs/reference/commands/slack_list.md @@ -2,7 +2,7 @@ List all authorized accounts -## Description +## Synopsis List all authorized accounts @@ -10,13 +10,19 @@ List all authorized accounts slack list [flags] ``` -## Flags +## Examples + +``` +$ slack auth list # List all authorized accounts +``` + +## Options ``` -h, --help help for list ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,13 +36,7 @@ slack list [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack auth list # List all authorized accounts -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_login.md b/docs/reference/commands/slack_login.md index 4187b969..f03b81b1 100644 --- a/docs/reference/commands/slack_login.md +++ b/docs/reference/commands/slack_login.md @@ -2,7 +2,7 @@ Log in to a Slack account -## Description +## Synopsis Log in to a Slack account in your team @@ -10,7 +10,23 @@ Log in to a Slack account in your team slack login [flags] ``` -## Flags +## Examples + +``` +# Login to a Slack account with prompts +$ slack auth login + +# Login to a Slack account without prompts, this returns a ticket +$ slack auth login --no-prompt + +# Complete login using ticket and challenge code +$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... + +# Login with a user token +$ slack auth login --token xoxp-... +``` + +## Options ``` --challenge string provide a challenge code for pre-authenticated login @@ -20,7 +36,7 @@ slack login [flags] --token string provide a token for a pre-authenticated login ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -33,23 +49,7 @@ slack login [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Login to a Slack account with prompts -$ slack auth login - -# Login to a Slack account without prompts, this returns a ticket -$ slack auth login --no-prompt - -# Complete login using ticket and challenge code -$ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... - -# Login with a user token -$ slack auth login --token xoxp-... -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_logout.md b/docs/reference/commands/slack_logout.md index 9132ec8d..ceaae8da 100644 --- a/docs/reference/commands/slack_logout.md +++ b/docs/reference/commands/slack_logout.md @@ -2,7 +2,7 @@ Log out of a team -## Description +## Synopsis Log out of a team, removing any local credentials @@ -10,14 +10,21 @@ Log out of a team, removing any local credentials slack logout [flags] ``` -## Flags +## Examples + +``` +$ slack auth logout # Select a team to log out of +$ slack auth logout --all # Log out of all team +``` + +## Options ``` -A, --all logout of all workspaces -h, --help help for logout ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -31,14 +38,7 @@ slack logout [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack auth logout # Select a team to log out of -$ slack auth logout --all # Log out of all team -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_manifest.md b/docs/reference/commands/slack_manifest.md index 2104964d..fb40bb45 100644 --- a/docs/reference/commands/slack_manifest.md +++ b/docs/reference/commands/slack_manifest.md @@ -2,7 +2,7 @@ Print the app manifest of a project or app -## Description +## Synopsis Get the manifest of an app using either the "remote" values on app settings or from the "local" configurations. @@ -17,14 +17,24 @@ Project configurations use the "get-manifest" hook from ".slack/hooks.json". slack manifest [flags] ``` -## Flags +## Examples + +``` +# Display the app manifest for the current project +$ slack manifest info + +# Validate the app manifest generated by a project +$ slack manifest validate +``` + +## Options ``` -h, --help help for manifest --source string source of the app manifest ("local" or "remote") ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,17 +48,7 @@ slack manifest [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Display the app manifest for the current project -$ slack manifest info - -# Validate the app manifest generated by a project -$ slack manifest validate -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack manifest info](slack_manifest_info) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_manifest_info.md b/docs/reference/commands/slack_manifest_info.md index a2421b88..96b9c8f9 100644 --- a/docs/reference/commands/slack_manifest_info.md +++ b/docs/reference/commands/slack_manifest_info.md @@ -2,7 +2,7 @@ Print the app manifest of a project or app -## Description +## Synopsis Get the manifest of an app using either the "remote" values on app settings or from the "local" configurations. @@ -15,14 +15,27 @@ Project configurations use the "get-manifest" hook from ".slack/hooks.json". slack manifest info [flags] ``` -## Flags +## Examples + +``` +# Print the app manifest from project configurations +$ slack manifest info + +# Print the remote manifest of an app +$ slack manifest info --app A0123456789 + +# Print the app manifest gathered from App Config +$ slack manifest info --source remote +``` + +## Options ``` -h, --help help for info --source string source of the app manifest ("local" or "remote") ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,20 +49,7 @@ slack manifest info [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Print the app manifest from project configurations -$ slack manifest info - -# Print the remote manifest of an app -$ slack manifest info --app A0123456789 - -# Print the app manifest gathered from App Config -$ slack manifest info --source remote -``` - -## See also +## SEE ALSO * [slack manifest](slack_manifest) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_manifest_validate.md b/docs/reference/commands/slack_manifest_validate.md index 921a5ab5..794ed4b7 100644 --- a/docs/reference/commands/slack_manifest_validate.md +++ b/docs/reference/commands/slack_manifest_validate.md @@ -2,7 +2,7 @@ Validate the app manifest generated by a project -## Description +## Synopsis Validate the app manifest generated from a valid project directory @@ -10,13 +10,20 @@ Validate the app manifest generated from a valid project directory slack manifest validate [flags] ``` -## Flags +## Examples + +``` +# Validate the app manifest generated by a project +$ slack manifest validate +``` + +## Options ``` -h, --help help for validate ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,14 +37,7 @@ slack manifest validate [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Validate the app manifest generated by a project -$ slack manifest validate -``` - -## See also +## SEE ALSO * [slack manifest](slack_manifest) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_platform.md b/docs/reference/commands/slack_platform.md index dd3b3888..cc035534 100644 --- a/docs/reference/commands/slack_platform.md +++ b/docs/reference/commands/slack_platform.md @@ -2,7 +2,7 @@ Deploy and run apps on the Slack Platform -## Description +## Synopsis Deploy and run apps on the Slack Platform @@ -10,13 +10,21 @@ Deploy and run apps on the Slack Platform slack platform [flags] ``` -## Flags +## Examples + +``` +$ slack run # Run an app locally in a workspace +$ slack deploy --team T0123456 # Deploy to a specific team +$ slack activity -t # Continuously poll for new activity logs +``` + +## Options ``` -h, --help help for platform ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,15 +38,7 @@ slack platform [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack run # Run an app locally in a workspace -$ slack deploy --team T0123456 # Deploy to a specific team -$ slack activity -t # Continuously poll for new activity logs -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack platform activity](slack_platform_activity) - Display the app activity logs from the Slack Platform diff --git a/docs/reference/commands/slack_platform_activity.md b/docs/reference/commands/slack_platform_activity.md index 5b866ea9..68e29cfe 100644 --- a/docs/reference/commands/slack_platform_activity.md +++ b/docs/reference/commands/slack_platform_activity.md @@ -2,7 +2,7 @@ Display the app activity logs from the Slack Platform -## Description +## Synopsis Display the app activity logs from the Slack Platform @@ -10,7 +10,14 @@ Display the app activity logs from the Slack Platform slack platform activity [flags] ``` -## Flags +## Examples + +``` +$ slack platform activity # Display app activity logs for an app +$ slack platform activity -t # Continuously poll for new activity logs +``` + +## Options ``` --component string component type to filter @@ -33,7 +40,7 @@ slack platform activity [flags] --trace-id string trace id to filter ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,14 +54,7 @@ slack platform activity [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack platform activity # Display app activity logs for an app -$ slack platform activity -t # Continuously poll for new activity logs -``` - -## See also +## SEE ALSO * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_platform_deploy.md b/docs/reference/commands/slack_platform_deploy.md index 3d11f9e3..48040110 100644 --- a/docs/reference/commands/slack_platform_deploy.md +++ b/docs/reference/commands/slack_platform_deploy.md @@ -2,7 +2,7 @@ Deploy the app to the Slack Platform -## Description +## Synopsis Deploy the app to the Slack Platform @@ -10,7 +10,15 @@ Deploy the app to the Slack Platform slack platform deploy [flags] ``` -## Flags +## Examples + +``` +# Select the workspace to deploy to +$ slack platform deploy +$ slack platform deploy --team T0123456 # Deploy to a specific team +``` + +## Options ``` -h, --help help for deploy @@ -19,7 +27,7 @@ slack platform deploy [flags] (or 'all' for all workspaces in the org) ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -33,15 +41,7 @@ slack platform deploy [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Select the workspace to deploy to -$ slack platform deploy -$ slack platform deploy --team T0123456 # Deploy to a specific team -``` - -## See also +## SEE ALSO * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_platform_run.md b/docs/reference/commands/slack_platform_run.md index 2f9c6cb1..62314829 100644 --- a/docs/reference/commands/slack_platform_run.md +++ b/docs/reference/commands/slack_platform_run.md @@ -2,7 +2,7 @@ Start a local server to develop and run the app locally -## Description +## Synopsis Start a local server to develop and run the app locally while watching for file changes @@ -10,7 +10,20 @@ Start a local server to develop and run the app locally while watching for file slack platform run [flags] ``` -## Flags +## Examples + +``` +# Start a local development server +$ slack platform run + +# Run a local development server with debug activity +$ slack platform run --activity-level debug + +# Run a local development server with cleanup +$ slack platform run --cleanup +``` + +## Options ``` --activity-level string activity level to display (default "info") @@ -22,7 +35,7 @@ slack platform run [flags] (or 'all' for all workspaces in the org) ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,20 +49,7 @@ slack platform run [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Start a local development server -$ slack platform run - -# Run a local development server with debug activity -$ slack platform run --activity-level debug - -# Run a local development server with cleanup -$ slack platform run --cleanup -``` - -## See also +## SEE ALSO * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_project.md b/docs/reference/commands/slack_project.md index 44f657b4..635b81e1 100644 --- a/docs/reference/commands/slack_project.md +++ b/docs/reference/commands/slack_project.md @@ -2,7 +2,7 @@ Create, manage, and doctor a project -## Description +## Synopsis Create, manage, and doctor a project and its configuration files. @@ -16,13 +16,26 @@ Check your project health and diagnose problems with the **doctor** command. slack project [flags] ``` -## Flags +## Examples + +``` +# Creates a new Slack project from an optional template +$ slack project create + +# Initialize an existing project to work with the Slack CLI +$ slack project init + +# Creates a new Slack project from the sample gallery +$ slack project samples +``` + +## Options ``` -h, --help help for project ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,20 +49,7 @@ slack project [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Creates a new Slack project from an optional template -$ slack project create - -# Initialize an existing project to work with the Slack CLI -$ slack project init - -# Creates a new Slack project from the sample gallery -$ slack project samples -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack project create](slack_project_create) - Create a new Slack project diff --git a/docs/reference/commands/slack_project_create.md b/docs/reference/commands/slack_project_create.md index 82cc0301..c9e0c2f1 100644 --- a/docs/reference/commands/slack_project_create.md +++ b/docs/reference/commands/slack_project_create.md @@ -2,7 +2,7 @@ Create a new Slack project -## Description +## Synopsis Create a new Slack project on your local machine from an optional template @@ -10,7 +10,17 @@ Create a new Slack project on your local machine from an optional template slack project create [name] [flags] ``` -## Flags +## Examples + +``` +# Create a new project from a template +$ slack create my-project + +# Start a new project from a specific template +$ slack create my-project -t slack-samples/deno-hello-world +``` + +## Options ``` -b, --branch string name of git branch to checkout @@ -18,7 +28,7 @@ slack project create [name] [flags] -t, --template string template URL for your app ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -32,17 +42,7 @@ slack project create [name] [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Create a new project from a template -$ slack create my-project - -# Start a new project from a specific template -$ slack create my-project -t slack-samples/deno-hello-world -``` - -## See also +## SEE ALSO * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_project_init.md b/docs/reference/commands/slack_project_init.md index 5926d57c..d7fa12a8 100644 --- a/docs/reference/commands/slack_project_init.md +++ b/docs/reference/commands/slack_project_init.md @@ -2,7 +2,7 @@ Initialize a project to work with the Slack CLI -## Description +## Synopsis Initializes a project to support the Slack CLI. @@ -30,13 +30,19 @@ Adds an existing app to your project (optional): slack project init [flags] ``` -## Flags +## Examples + +``` +$ slack init # Initialize a project +``` + +## Options ``` -h, --help help for init ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -50,13 +56,7 @@ slack project init [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack init # Initialize a project -``` - -## See also +## SEE ALSO * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_project_samples.md b/docs/reference/commands/slack_project_samples.md index a2899aa0..3dfe9510 100644 --- a/docs/reference/commands/slack_project_samples.md +++ b/docs/reference/commands/slack_project_samples.md @@ -2,25 +2,29 @@ List available sample apps -## Description +## Synopsis List and create an app from the available samples ``` -slack project samples [name] [flags] +slack project samples [flags] ``` -## Flags +## Examples + +``` +$ slack samples # Select a sample app to create +``` + +## Options ``` -b, --branch string name of git branch to checkout -h, --help help for samples - --language string runtime for the app framework - ex: "deno", "node", "python" -t, --template string template URL for your app ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -34,13 +38,7 @@ slack project samples [name] [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack samples my-project # Select a sample app to create -``` - -## See also +## SEE ALSO * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_run.md b/docs/reference/commands/slack_run.md index fb7517fa..6d3d436d 100644 --- a/docs/reference/commands/slack_run.md +++ b/docs/reference/commands/slack_run.md @@ -2,7 +2,7 @@ Start a local server to develop and run the app locally -## Description +## Synopsis Start a local server to develop and run the app locally while watching for file changes @@ -10,7 +10,20 @@ Start a local server to develop and run the app locally while watching for file slack run [flags] ``` -## Flags +## Examples + +``` +# Start a local development server +$ slack platform run + +# Run a local development server with debug activity +$ slack platform run --activity-level debug + +# Run a local development server with cleanup +$ slack platform run --cleanup +``` + +## Options ``` --activity-level string activity level to display (default "info") @@ -22,7 +35,7 @@ slack run [flags] (or 'all' for all workspaces in the org) ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,20 +49,7 @@ slack run [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Start a local development server -$ slack platform run - -# Run a local development server with debug activity -$ slack platform run --activity-level debug - -# Run a local development server with cleanup -$ slack platform run --cleanup -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_samples.md b/docs/reference/commands/slack_samples.md index 7bb84a80..c4f4ac4f 100644 --- a/docs/reference/commands/slack_samples.md +++ b/docs/reference/commands/slack_samples.md @@ -2,25 +2,29 @@ List available sample apps -## Description +## Synopsis List and create an app from the available samples ``` -slack samples [name] [flags] +slack samples [flags] ``` -## Flags +## Examples + +``` +$ slack samples # Select a sample app to create +``` + +## Options ``` -b, --branch string name of git branch to checkout -h, --help help for samples - --language string runtime for the app framework - ex: "deno", "node", "python" -t, --template string template URL for your app ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -34,13 +38,7 @@ slack samples [name] [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack samples my-project # Select a sample app to create -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_trigger.md b/docs/reference/commands/slack_trigger.md index 05ba3463..f62c6687 100644 --- a/docs/reference/commands/slack_trigger.md +++ b/docs/reference/commands/slack_trigger.md @@ -2,7 +2,7 @@ List details of existing triggers -## Description +## Synopsis List details of existing triggers @@ -10,26 +10,6 @@ List details of existing triggers slack trigger [flags] ``` -## Flags - -``` - -h, --help help for trigger -``` - -## 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 ``` @@ -50,7 +30,27 @@ $ slack trigger list $ slack trigger update --trigger-id Ft01234ABCD ``` -## See also +## Options + +``` + -h, --help help for trigger +``` + +## 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](slack) - Slack command-line tool * [slack trigger access](slack_trigger_access) - Manage who can use your triggers diff --git a/docs/reference/commands/slack_trigger_access.md b/docs/reference/commands/slack_trigger_access.md index f44386b1..11d23bb9 100644 --- a/docs/reference/commands/slack_trigger_access.md +++ b/docs/reference/commands/slack_trigger_access.md @@ -2,7 +2,7 @@ Manage who can use your triggers -## Description +## Synopsis Manage who can use your triggers @@ -10,7 +10,22 @@ Manage who can use your triggers slack trigger access --trigger-id [flags] ``` -## Flags +## Examples + +``` +# Grant everyone access to run a trigger +$ slack trigger access --trigger-id Ft01234ABCD --everyone + +# Grant certain channels access to run a trigger +$ slack trigger access --trigger-id Ft01234ABCD --grant \ + --channels C012345678 + +# Revoke certain users access to run a trigger +$ slack trigger access --trigger-id Ft01234ABCD --revoke \ + --users USLACKBOT,U012345678 +``` + +## Options ``` -A, --app-collaborators grant permission to only app collaborators @@ -30,7 +45,7 @@ slack trigger access --trigger-id [flags] -W, --workspaces string a comma-separated list of Slack workspace IDs ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -44,22 +59,7 @@ slack trigger access --trigger-id [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Grant everyone access to run a trigger -$ slack trigger access --trigger-id Ft01234ABCD --everyone - -# Grant certain channels access to run a trigger -$ slack trigger access --trigger-id Ft01234ABCD --grant \ - --channels C012345678 - -# Revoke certain users access to run a trigger -$ slack trigger access --trigger-id Ft01234ABCD --revoke \ - --users USLACKBOT,U012345678 -``` - -## See also +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_create.md b/docs/reference/commands/slack_trigger_create.md index 59971143..a0457d9d 100644 --- a/docs/reference/commands/slack_trigger_create.md +++ b/docs/reference/commands/slack_trigger_create.md @@ -2,7 +2,7 @@ Create a trigger for a workflow -## Description +## Synopsis Create a trigger to start a workflow @@ -10,7 +10,20 @@ Create a trigger to start a workflow slack trigger create [flags] ``` -## Flags +## Examples + +``` +# Create a trigger by selecting an app and trigger definition +$ slack trigger create + +# Create a trigger from a definition file +$ slack trigger create --trigger-def "triggers/shortcut_trigger.ts" + +# Create a trigger for a workflow +$ slack trigger create --workflow "#/workflows/my_workflow" +``` + +## Options ``` --description string the description of this trigger @@ -34,7 +47,7 @@ slack trigger create [flags] "#/workflows/" ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -48,20 +61,7 @@ slack trigger create [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Create a trigger by selecting an app and trigger definition -$ slack trigger create - -# Create a trigger from a definition file -$ slack trigger create --trigger-def "triggers/shortcut_trigger.ts" - -# Create a trigger for a workflow -$ slack trigger create --workflow "#/workflows/my_workflow" -``` - -## See also +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_delete.md b/docs/reference/commands/slack_trigger_delete.md index e43cca83..386ebdaf 100644 --- a/docs/reference/commands/slack_trigger_delete.md +++ b/docs/reference/commands/slack_trigger_delete.md @@ -2,7 +2,7 @@ Delete an existing trigger -## Description +## Synopsis Delete an existing trigger @@ -10,14 +10,24 @@ Delete an existing trigger slack trigger delete --trigger-id [flags] ``` -## Flags +## Examples + +``` +# Delete a specific trigger in a selected workspace +$ slack trigger delete --trigger-id Ft01234ABCD + +# Delete a specific trigger for an app +$ slack trigger delete --trigger-id Ft01234ABCD --app A0123456 +``` + +## Options ``` -h, --help help for delete --trigger-id string the ID of the trigger ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -31,17 +41,7 @@ slack trigger delete --trigger-id [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Delete a specific trigger in a selected workspace -$ slack trigger delete --trigger-id Ft01234ABCD - -# Delete a specific trigger for an app -$ slack trigger delete --trigger-id Ft01234ABCD --app A0123456 -``` - -## See also +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_info.md b/docs/reference/commands/slack_trigger_info.md index 12064e01..b58b08bd 100644 --- a/docs/reference/commands/slack_trigger_info.md +++ b/docs/reference/commands/slack_trigger_info.md @@ -2,7 +2,7 @@ Get details for a specific trigger -## Description +## Synopsis Get details for a specific trigger @@ -10,14 +10,24 @@ Get details for a specific trigger slack trigger info --trigger-id [flags] ``` -## Flags +## Examples + +``` +# Get details for a specific trigger in a selected workspace +$ slack trigger info --trigger-id Ft01234ABCD + +# Get details for a specific trigger +$ slack trigger info --trigger-id Ft01234ABCD --app A0123456 +``` + +## Options ``` -h, --help help for info --trigger-id string the ID of the trigger ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -31,17 +41,7 @@ slack trigger info --trigger-id [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Get details for a specific trigger in a selected workspace -$ slack trigger info --trigger-id Ft01234ABCD - -# Get details for a specific trigger -$ slack trigger info --trigger-id Ft01234ABCD --app A0123456 -``` - -## See also +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_list.md b/docs/reference/commands/slack_trigger_list.md index 4bec07f6..a46a0fe0 100644 --- a/docs/reference/commands/slack_trigger_list.md +++ b/docs/reference/commands/slack_trigger_list.md @@ -2,7 +2,7 @@ List details of existing triggers -## Description +## Synopsis List details of existing triggers @@ -10,7 +10,17 @@ List details of existing triggers slack trigger list [flags] ``` -## Flags +## Examples + +``` +# List details for all existing triggers +$ slack trigger list + +# List triggers for a specific app +$ slack trigger list --team T0123456 --app local +``` + +## Options ``` -h, --help help for list @@ -18,7 +28,7 @@ slack trigger list [flags] -T, --type string Only display triggers of the given type, can be one of 'all', 'shortcut', 'event', 'scheduled', 'webhook', and 'external' (default "all") ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -32,17 +42,7 @@ slack trigger list [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# List details for all existing triggers -$ slack trigger list - -# List triggers for a specific app -$ slack trigger list --team T0123456 --app local -``` - -## See also +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_update.md b/docs/reference/commands/slack_trigger_update.md index d4f0c0c1..117b1f14 100644 --- a/docs/reference/commands/slack_trigger_update.md +++ b/docs/reference/commands/slack_trigger_update.md @@ -2,7 +2,7 @@ Updates an existing trigger -## Description +## Synopsis Updates an existing trigger with the provided definition. Only supports full replacement, no partial update. @@ -10,7 +10,18 @@ Updates an existing trigger with the provided definition. Only supports full rep slack trigger update --trigger-id [flags] ``` -## Flags +## Examples + +``` +# Update a trigger definition with a selected file +$ slack trigger update --trigger-id Ft01234ABCD + +# Update a trigger with a workflow id and title +$ slack trigger update --trigger-id Ft01234ABCD \ + --workflow "#/workflows/my_workflow" --title "Updated trigger" +``` + +## Options ``` --description string the description of this trigger @@ -33,7 +44,7 @@ slack trigger update --trigger-id [flags] "#/workflows/" ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,18 +58,7 @@ slack trigger update --trigger-id [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -# Update a trigger definition with a selected file -$ slack trigger update --trigger-id Ft01234ABCD - -# Update a trigger with a workflow id and title -$ slack trigger update --trigger-id Ft01234ABCD \ - --workflow "#/workflows/my_workflow" --title "Updated trigger" -``` - -## See also +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_uninstall.md b/docs/reference/commands/slack_uninstall.md index 0fa31872..c947a4d2 100644 --- a/docs/reference/commands/slack_uninstall.md +++ b/docs/reference/commands/slack_uninstall.md @@ -2,7 +2,7 @@ Uninstall the app from a team -## Description +## Synopsis Uninstall the app from a team without deleting the app or its data @@ -10,13 +10,19 @@ Uninstall the app from a team without deleting the app or its data slack uninstall [flags] ``` -## Flags +## Examples + +``` +$ slack app uninstall # Uninstall an app from a team +``` + +## Options ``` -h, --help help for uninstall ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,13 +36,7 @@ slack uninstall [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack app uninstall # Uninstall an app from a team -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_upgrade.md b/docs/reference/commands/slack_upgrade.md index 60db40ad..8267c6b7 100644 --- a/docs/reference/commands/slack_upgrade.md +++ b/docs/reference/commands/slack_upgrade.md @@ -2,7 +2,7 @@ Checks for available updates to the CLI or SDK -## Description +## Synopsis Checks for available updates to the CLI or the SDKs of a project @@ -14,13 +14,19 @@ The changelog can be found at [https://docs.slack.dev/changelog](https://docs.sl slack upgrade [flags] ``` -## Flags +## Examples + +``` +$ slack upgrade # Check for any available updates +``` + +## Options ``` -h, --help help for upgrade ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -34,13 +40,7 @@ slack upgrade [flags] -v, --verbose print debug logging and additional info ``` -## Examples - -``` -$ slack upgrade # Check for any available updates -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_version.md b/docs/reference/commands/slack_version.md index e049be3e..2169942e 100644 --- a/docs/reference/commands/slack_version.md +++ b/docs/reference/commands/slack_version.md @@ -2,7 +2,7 @@ Print the version number -## Description +## Synopsis All software has versions. This is ours. @@ -30,13 +30,21 @@ Given a version number `v3.0.1-7-g822d09a`: slack version [flags] ``` -## 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 ``` -h, --help help for version ``` -## Global flags +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -50,15 +58,7 @@ slack version [flags] -v, --verbose print debug logging and additional info ``` -## 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 -``` - -## See also +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/errors.md b/docs/reference/errors.md index 0f982b0f..bdf735b6 100644 --- a/docs/reference/errors.md +++ b/docs/reference/errors.md @@ -71,7 +71,7 @@ and some ways to remediate them. **Message**: Specified app and team are mismatched -**Remediation**: Try a different combination of `--app` and `--team` flags +**Remediation**: Try a different combination of --app, --team flags --- @@ -498,12 +498,6 @@ Approval is pending review --- -### documentation_generation_failed {#documentation_generation_failed} - -**Message**: Failed to generate documentation - ---- - ### enterprise_not_found {#enterprise_not_found} **Message**: The `enterprise` was not found @@ -572,7 +566,7 @@ Approval is pending review **Message**: The name of the feedback is required -**Remediation**: Please provide a `--name ` flag or remove the `--no-prompt` flag +**Remediation**: Please provide a `--name ` flag or remove the --no-prompt flag View feedback options with `slack feedback --help` --- @@ -719,7 +713,7 @@ If this is a Slack project, you can initialize it with `slack init` **Message**: The provided --app flag value is not valid -**Remediation**: Specify the environment with `--app local` or `--app deployed` +**Remediation**: Specify the environment with --app local or --app deployed Or choose a specific app with `--app ` --- @@ -1245,17 +1239,9 @@ Read about manifest sourcing with the `slack manifest info --help` command --- -### runtime_not_found {#runtime_not_found} - -**Message**: The hook runtime executable was not found - -**Remediation**: Make sure the required runtime has been installed to run hook scripts. - ---- - ### runtime_not_supported {#runtime_not_supported} -**Message**: The SDK runtime is not supported by the CLI +**Message**: The SDK language's executable (deno, node, python, etc) was not found to be installed on the system --- @@ -1279,6 +1265,14 @@ Read about manifest sourcing with the `slack manifest info --help` command --- +### sdk_hook_get_trigger_not_found {#sdk_hook_get_trigger_not_found} + +**Message**: The `get-trigger` hook script in `.slack/hooks.json` was not found + +**Remediation**: Try defining your trigger by specifying a json file instead. + +--- + ### sdk_hook_invocation_failed {#sdk_hook_invocation_failed} **Message**: A script hook defined in the Slack Configuration file (`.slack/hooks.json`) returned an error @@ -1296,7 +1290,7 @@ Read about manifest sourcing with the `slack manifest info --help` command - .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/hooks.json +https://github.com/slack-samples/deno-starter-template/blob/main/slack.json You can create a hooks file manually or with the `slack init` command.