Skip to content

Commit 21a442e

Browse files
lukegalbraithrusselllukegalbraithrussell
committed
adds files as test
1 parent 859d4f1 commit 21a442e

File tree

75 files changed

+3911
-37
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+3911
-37
lines changed

‎.github/workflows/slack-cli-generate-docs.yaml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Generate Slack CLI Docs
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
update-docs:
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
12+
- name: Install Slack CLI
13+
run: |
14+
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash
15+
16+
- name: Generate a GitHub token
17+
id: ghtoken
18+
uses: actions/create-github-app-token@v2
19+
with:
20+
app-id: ${{ secrets.GH_APP_ID }}
21+
owner: slackapi
22+
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
23+
24+
- name: Checkout code
25+
uses: actions/checkout@v4
26+
27+
- name: Generate docs
28+
run: |
29+
slack docgen content/slack-cli/reference
30+
31+
- name: Create a pull request
32+
uses: peter-evans/create-pull-request@v7
33+
with:
34+
token: ${{ steps.ghtoken.outputs.token }}
35+
title: "Automated Slack CLI reference docs for release"
36+
body: "Automatically updating Slack CLI docs following release"
37+
author: "slackapi[bot] <186980925+slackapi[bot]@users.noreply.github.com>"
38+
committer: "slackapi[bot] <186980925+slackapi[bot]@users.noreply.github.com>"
39+
commit-message: "Update slack cli reference docs"
40+
base: "main"
41+
branch: "update-slack-cli-reference"
42+
delete-branch: true
43+
labels: docs

‎docs/reference/commands/slackk.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## slackk
2+
3+
Slack command-line tool
4+
5+
### Synopsis
6+
7+
{{Emoji "sparkles"}}CLI to create, run, and deploy Slack apps
8+
9+
{{Emoji "books"}}Get started by reading the docs: {{LinkText "https://docs.slack.dev/tools/slack-cli"}}
10+
11+
```
12+
slackk <command> <subcommand> [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
$ slackk login # Log in to your Slack account
19+
$ slackk create # Create a new Slack app
20+
$ slackk init # Initialize an existing Slack app
21+
$ slackk run # Start a local development server
22+
$ slackk deploy # Deploy to the Slack Platform
23+
```
24+
25+
### Options
26+
27+
```
28+
-a, --app string use a specific app ID or environment
29+
--config-dir string use a custom path for system config directory
30+
-e, --experiment strings use the experiment(s) in the command
31+
-f, --force ignore warnings and continue executing command
32+
-h, --help help for slackk
33+
--no-color remove styles and formatting from outputs
34+
-s, --skip-update skip checking for latest version of CLI
35+
-w, --team string select workspace or organization by team name or ID
36+
--token string set the access token associated with a team
37+
-v, --verbose print debug logging and additional info
38+
```
39+
40+
### SEE ALSO
41+
42+
* [slackk activity](slackk_activity.md) - Display the app activity logs from the Slack Platform
43+
* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed
44+
* [slackk auth](slackk_auth.md) - Add and remove local team authorizations
45+
* [slackk collaborator](slackk_collaborator.md) - Manage app collaborators
46+
* [slackk create](slackk_create.md) - Create a new Slack project
47+
* [slackk datastore](slackk_datastore.md) - Interact with an app's datastore
48+
* [slackk delete](slackk_delete.md) - Delete the app
49+
* [slackk deploy](slackk_deploy.md) - Deploy the app to the Slack Platform
50+
* [slackk doctor](slackk_doctor.md) - Check and report on system and app information
51+
* [slackk env](slackk_env.md) - Add, remove, or list environment variables
52+
* [slackk external-auth](slackk_external-auth.md) - Adjust settings of external authentication providers
53+
* [slackk feedback](slackk_feedback.md) - Share feedback about your experience or project
54+
* [slackk function](slackk_function.md) - Manage the functions of an app
55+
* [slackk init](slackk_init.md) - Initialize a project to work with the Slack CLI
56+
* [slackk install](slackk_install.md) - Install the app to a team
57+
* [slackk list](slackk_list.md) - List all authorized accounts
58+
* [slackk login](slackk_login.md) - Log in to a Slack account
59+
* [slackk logout](slackk_logout.md) - Log out of a team
60+
* [slackk manifest](slackk_manifest.md) - Print the app manifest of a project or app
61+
* [slackk platform](slackk_platform.md) - Deploy and run apps on the Slack Platform
62+
* [slackk project](slackk_project.md) - Create, manage, and doctor a project
63+
* [slackk run](slackk_run.md) - Start a local server to develop and run the app locally
64+
* [slackk samples](slackk_samples.md) - List available sample apps
65+
* [slackk trigger](slackk_trigger.md) - List details of existing triggers
66+
* [slackk uninstall](slackk_uninstall.md) - Uninstall the app from a team
67+
* [slackk upgrade](slackk_upgrade.md) - Checks for available updates to the CLI or SDK
68+
* [slackk version](slackk_version.md) - Print the version number
69+

‎docs/reference/commands/slackk_activity.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## slackk activity
2+
3+
Display the app activity logs from the Slack Platform
4+
5+
### Synopsis
6+
7+
Display the app activity logs from the Slack Platform
8+
9+
```
10+
slackk activity [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
$ slackk platform activity # Display app activity logs for an app
17+
$ slackk platform activity -t # Continuously poll for new activity logs
18+
```
19+
20+
### Options
21+
22+
```
23+
--component string component type to filter
24+
--component-id string component id to filter
25+
(either a function id or workflow id)
26+
--event string event type to filter
27+
-h, --help help for activity
28+
--idle int time to poll without results before exiting
29+
in minutes (default 5)
30+
-i, --interval int polling interval in seconds (default 3)
31+
--level string minimum log level to display (default "info")
32+
(trace, debug, info, warn, error, fatal)
33+
--limit int limit the amount of logs retrieved (default 100)
34+
--max-date-created int maximum timestamp to filter
35+
(unix timestamp in microseconds)
36+
--min-date-created int minimum timestamp to filter
37+
(unix timestamp in microseconds)
38+
--source string source (slack or developer) to filter
39+
-t, --tail continuously poll for new activity
40+
--trace-id string trace id to filter
41+
```
42+
43+
### Options inherited from parent commands
44+
45+
```
46+
-a, --app string use a specific app ID or environment
47+
--config-dir string use a custom path for system config directory
48+
-e, --experiment strings use the experiment(s) in the command
49+
-f, --force ignore warnings and continue executing command
50+
--no-color remove styles and formatting from outputs
51+
-s, --skip-update skip checking for latest version of CLI
52+
-w, --team string select workspace or organization by team name or ID
53+
--token string set the access token associated with a team
54+
-v, --verbose print debug logging and additional info
55+
```
56+
57+
### SEE ALSO
58+
59+
* [slackk](slackk.md) - Slack command-line tool
60+

‎docs/reference/commands/slackk_app.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## slackk app
2+
3+
Install, uninstall, and list teams with the app installed
4+
5+
### Synopsis
6+
7+
Install, uninstall, and list teams with the app installed
8+
9+
```
10+
slackk app [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
$ slackk app install # Install a production app to a team
17+
$ slackk app link # Link an existing app to the project
18+
$ slackk app list # List all teams with the app installed
19+
$ slackk app settings # Open app settings in a web browser
20+
$ slackk app uninstall # Uninstall an app from a team
21+
$ slackk app delete # Delete an app and app info from a team
22+
```
23+
24+
### Options
25+
26+
```
27+
-h, --help help for app
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-a, --app string use a specific app ID or environment
34+
--config-dir string use a custom path for system config directory
35+
-e, --experiment strings use the experiment(s) in the command
36+
-f, --force ignore warnings and continue executing command
37+
--no-color remove styles and formatting from outputs
38+
-s, --skip-update skip checking for latest version of CLI
39+
-w, --team string select workspace or organization by team name or ID
40+
--token string set the access token associated with a team
41+
-v, --verbose print debug logging and additional info
42+
```
43+
44+
### SEE ALSO
45+
46+
* [slackk](slackk.md) - Slack command-line tool
47+
* [slackk app delete](slackk_app_delete.md) - Delete the app
48+
* [slackk app install](slackk_app_install.md) - Install the app to a team
49+
* [slackk app link](slackk_app_link.md) - Add an existing app to the project
50+
* [slackk app list](slackk_app_list.md) - List teams with the app installed
51+
* [slackk app settings](slackk_app_settings.md) - Open app settings for configurations
52+
* [slackk app uninstall](slackk_app_uninstall.md) - Uninstall the app from a team
53+

‎docs/reference/commands/slackk_app_delete.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## slackk app delete
2+
3+
Delete the app
4+
5+
### Synopsis
6+
7+
Uninstall the app from the team and permanently delete the app and all of its data
8+
9+
```
10+
slackk app delete [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
# Delete an app and app info from a team
17+
$ slackk app delete
18+
19+
# Delete a specific app from a team
20+
$ slackk app delete --team T0123456 --app local
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help help for delete
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-a, --app string use a specific app ID or environment
33+
--config-dir string use a custom path for system config directory
34+
-e, --experiment strings use the experiment(s) in the command
35+
-f, --force ignore warnings and continue executing command
36+
--no-color remove styles and formatting from outputs
37+
-s, --skip-update skip checking for latest version of CLI
38+
-w, --team string select workspace or organization by team name or ID
39+
--token string set the access token associated with a team
40+
-v, --verbose print debug logging and additional info
41+
```
42+
43+
### SEE ALSO
44+
45+
* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed
46+

‎docs/reference/commands/slackk_app_install.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## slackk app install
2+
3+
Install the app to a team
4+
5+
### Synopsis
6+
7+
Install the app to a team
8+
9+
```
10+
slackk app install [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
# Install a production app to a team
17+
$ slackk app install
18+
19+
# Install a production app to a specific team
20+
$ slackk app install --team T0123456 --environment deployed
21+
22+
# Install a local dev app to a specific team
23+
$ slackk app install --team T0123456 --environment local
24+
```
25+
26+
### Options
27+
28+
```
29+
-E, --environment string environment of app (local, deployed)
30+
-h, --help help for install
31+
--org-workspace-grant string grant access to a specific org workspace ID
32+
(or 'all' for all workspaces in the org)
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
-a, --app string use a specific app ID or environment
39+
--config-dir string use a custom path for system config directory
40+
-e, --experiment strings use the experiment(s) in the command
41+
-f, --force ignore warnings and continue executing command
42+
--no-color remove styles and formatting from outputs
43+
-s, --skip-update skip checking for latest version of CLI
44+
-w, --team string select workspace or organization by team name or ID
45+
--token string set the access token associated with a team
46+
-v, --verbose print debug logging and additional info
47+
```
48+
49+
### SEE ALSO
50+
51+
* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed
52+

‎docs/reference/commands/slackk_app_link.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## slackk app link
2+
3+
Add an existing app to the project
4+
5+
### Synopsis
6+
7+
Saves an existing app to a project to be available to other commands.
8+
9+
The provided App ID and Team ID are stored in the apps.json or apps.dev.json
10+
files in the .slack directory of a project.
11+
12+
The environment option decides how an app is handled and where information
13+
should be stored. Production apps should be 'deployed' while apps used for
14+
testing and development should be considered 'local'.
15+
16+
Only one app can exist for each combination of Team ID and environment.
17+
18+
```
19+
slackk app link [flags]
20+
```
21+
22+
### Examples
23+
24+
```
25+
# Add an existing app to a project
26+
$ slackk app link
27+
28+
# Add a specific app without using prompts
29+
$ slackk app link --team T0123456789 --app A0123456789 --environment deployed
30+
```
31+
32+
### Options
33+
34+
```
35+
-E, --environment string environment to save existing app (local, deployed)
36+
-h, --help help for link
37+
```
38+
39+
### Options inherited from parent commands
40+
41+
```
42+
-a, --app string use a specific app ID or environment
43+
--config-dir string use a custom path for system config directory
44+
-e, --experiment strings use the experiment(s) in the command
45+
-f, --force ignore warnings and continue executing command
46+
--no-color remove styles and formatting from outputs
47+
-s, --skip-update skip checking for latest version of CLI
48+
-w, --team string select workspace or organization by team name or ID
49+
--token string set the access token associated with a team
50+
-v, --verbose print debug logging and additional info
51+
```
52+
53+
### SEE ALSO
54+
55+
* [slackk app](slackk_app.md) - Install, uninstall, and list teams with the app installed
56+

0 commit comments

Comments
 (0)