feat: adds `docs` command with optional search flag by lukegalbraithrussell · Pull Request #352 · slackapi/slack-cli

lukegalbraithrussell · 2026-02-24T21:54:44Z

Changelog

The slack docs command opens the slack docs site; its --search flag opens the slack docs search page with the provided search query.

Summary

This PR adds a docs command.

Command	Result
`slack docs`	opens `docs.slack.dev`
`slack docs --search`	opens `docs.slack.dev/search`
`slack docs --search "something cool"`	`docs.slack.dev/search/?q=something+cool`
`slack docs "something cool"`	`docs.slack.dev/search/?q=something+cool`

This doesn't take advantage of the charm experiment. Next steps though!!!

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2026-02-24T23:20:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.67%. Comparing base (1059ec2) to head (35153a9).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #352      +/-   ##
==========================================
+ Coverage   64.48%   64.67%   +0.18%     
==========================================
  Files         213      214       +1     
  Lines       17879    17974      +95     
==========================================
+ Hits        11530    11625      +95     
+ Misses       5276     5272       -4     
- Partials     1073     1077       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

lukegalbraithrussell · 2026-02-25T17:07:29Z

cmd/docs/docs_test.go

+	"github.com/stretchr/testify/mock"
+)
+
+func Test_Docs_DocsCommand(t *testing.T) {


valid if these are too many tests lol

@lukegalbraithrussell These are solid cases to cover! It makes me confident that we're covering edge cases from the start 🤓

zimeg

☕️ Leaving a few notes from the coffee shop-

zimeg · 2026-02-26T16:14:45Z

cmd/docs/docs.go

+
+	clients.Browser().OpenURL(docsURL)
+
+	// Add trace for analytics


🧪 note: We use these traces for testing certain paths are reached in our E2E tests:

$ SLACK_TEST_TRACE=1 slack docs

It might be nice to update or remove this comment to avoid ongoing confusion toward this!

zimeg · 2026-02-26T16:17:53Z

cmd/docs/docs.go

+	clients.IO.PrintInfo(ctx, false, "\n%s", style.Sectionf(style.TextSection{
+		Emoji: "books",
+		Text:  sectionText,
+		Secondary: []string{
+			docsURL,
+		},
+	}))


📠 suggestion: Our sytles are not so consistent but we might want to use the command name for "text" with more details following?

📚 Docs Open https://docs.slack.dev/

Or

📚 Docs Search https://docs.slack.dev/search?q=chatbot

super good point! changed it

zimeg · 2026-02-26T16:19:03Z

cmd/docs/docs_test.go

+	"github.com/stretchr/testify/mock"
+)
+
+func Test_Docs_DocsCommand(t *testing.T) {


@lukegalbraithrussell These are solid cases to cover! It makes me confident that we're covering edge cases from the start 🤓

…into docs-command

lukegalbraithrussell · 2026-02-26T16:53:17Z

@zimeg thank you kindly for the coffee shop review. i've updated per your suggestion (while drinking coffee but at home alas)

zimeg

@lukegalbraithrussell I appreciate the fast changes! Coffee finds me good too in the office ☕ ✨

I'm leaving a few more comments about the standalone search patterns. This is a smooth path to a familiar search experience that I'd like to support, but feel free to hold off on those changes if it's not envisioned 👁️‍🗨️

zimeg · 2026-02-26T16:57:29Z

cmd/docs/docs_test.go

+		"handles empty search query as homepage": {
+			CmdArgs: []string{"--search", ""},
+			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
+				expectedURL := "https://docs.slack.dev"
+				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.DocsSuccess, mock.Anything)
+			},
+			ExpectedOutputs: []string{
+				"Docs Open",
+				"https://docs.slack.dev",
+			},
+		},


🧪 issue: This case is a bit misleading to me! I tried using the search flag without an argument to find this error:

$ slack docs --search Check /Users/eden.zimbelman/.slack/logs/slack-debug-20260226.log for error logs flag needs an argument: --search

should this instead open docs.slack.dev/search?

I do think this would be ideal - perhaps "https://docs.slack.dev/search/" complete - if possible, without an argument?

zimeg · 2026-02-26T17:04:23Z

cmd/root.go

 			{Command: "init", Meaning: "Initialize an existing Slack app"},
 			{Command: "run", Meaning: "Start a local development server"},
 			{Command: "deploy", Meaning: "Deploy to the Slack Platform"},
+			{Command: "docs", Meaning: "Open Slack developer docs"},


📚 praise: This is nice to find toward the bottom of help alongside other calls to action!

zimeg · 2026-02-26T17:09:29Z

cmd/docs/docs.go

+		},
+	}
+
+	cmd.Flags().StringVar(&searchFlag, "search", "", "search query for Slack docs")


🪬 suggestion: Related to the "required" search value if the "--search" flag is provided - I wonder if we can change this to be a "boolean" value?

This might allow this command to accept 1 argument instead of 0 for sake of being the search query? We might then search if that flag is provided or if an argument is used:

$ slack docs --search $ slack docs "Block Kit" $ slack docs --search "Block Kit"

We ought not need to document the second case IMHO since it's identical to the third, and I don't think such approach limits future changes. Not a blocker here but the examples might need updating before merge!

zimeg

💡 @lukegalbraithrussell This is getting so good! I'm leaving one more comment of edge cases found, but I'm so optimistic!

zimeg · 2026-02-26T22:40:09Z

cmd/docs/docs.go

+	var sectionText string
+
+	// Validate: if there are arguments, --search flag must be used
+	if len(args) > 0 && !cmd.Flags().Changed("search") {


🪬 suggestion: We might still want to keep a max arguments setting for this command, but set to 1. It can be confusing otherwise to find:

(.venv) $ lack docs --search one two 📚 Docs Search https://docs.slack.dev/search/?q=one

Although we can also update this section with "variadic" arguments to join the arguments together - IMHO this might be ideal if not so complicated 👻

lukegalbraithrussell and others added 5 commits February 24, 2026 13:54

adds command

90dff7c

Merge branch 'main' into docs-command

c252cd7

docs not documentation

5fd56a2

go

45396a6

cleaning up tests

2c2c5e8

lukegalbraithrussell and others added 2 commits February 25, 2026 08:59

better test value

6af0af7

Merge branch 'main' into docs-command

04854d0

lukegalbraithrussell changed the title ~~Feat: adds docs command with optional search param~~ Feat: adds docs command with optional search flag Feb 25, 2026

lukegalbraithrussell commented Feb 25, 2026

View reviewed changes

lukegalbraithrussell marked this pull request as ready for review February 25, 2026 17:27

lukegalbraithrussell requested a review from a team as a code owner February 25, 2026 17:27

zimeg reviewed Feb 26, 2026

View reviewed changes

zimeg changed the title ~~Feat: adds docs command with optional search flag~~ feat: adds docs command with optional search flag Feb 26, 2026

zimeg added enhancement M-T: A feature request for new functionality changelog Use on updates to be included in the release notes semver:minor Use on pull requests to describe the release version increment labels Feb 26, 2026

zimeg added this to the Next Release milestone Feb 26, 2026

lukegalbraithrussell added 2 commits February 26, 2026 08:50

feedback from edengod

aad04d0

Merge branch 'docs-command' of https://github.com/slackapi/slack-cli …

9c8bb4c

…into docs-command

zimeg reviewed Feb 26, 2026

View reviewed changes

lukegalbraithrussell added 3 commits February 26, 2026 10:25

go

1d12927

updates to be better

29ee8ee

lint

35153a9

lukegalbraithrussell requested a review from zimeg February 26, 2026 22:05

zimeg reviewed Feb 26, 2026

View reviewed changes

takes all inputs

7a2b2b9


		clients.Browser().OpenURL(docsURL)

		// Add trace for analytics

Conversation

lukegalbraithrussell commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Summary

Requirements

Uh oh!

codecov bot commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimeg Feb 26, 2026 • edited by lukegalbraithrussell Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukegalbraithrussell commented Feb 26, 2026

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lukegalbraithrussell commented Feb 24, 2026 •

edited

Loading

codecov bot commented Feb 24, 2026 •

edited

Loading

zimeg Feb 26, 2026 •

edited by lukegalbraithrussell

Loading