Skip to content

fix(docs): correct search examples in SKILL.md to use --cql flag#84

Merged
pchuri merged 1 commit intopchuri:mainfrom
sincerity711:fix/search-skill-docs
Mar 26, 2026
Merged

fix(docs): correct search examples in SKILL.md to use --cql flag#84
pchuri merged 1 commit intopchuri:mainfrom
sincerity711:fix/search-skill-docs

Conversation

@sincerity711
Copy link
Copy Markdown
Contributor

Summary

  • The search examples in SKILL.md showed raw CQL passed as a plain query string (e.g. confluence search "type=page AND space=MYSPACE"), but without the --cql flag this is treated as a literal text search (text ~ "type=page AND space=MYSPACE"), not a CQL query
  • Added --cql option to the search command reference table
  • Updated examples to use --cql with siteSearch ~ which works more reliably on Confluence Server/DC

Test plan

  • Verified confluence search --cql 'siteSearch ~ "keyword" and space = "SPACE"' returns correct results
  • Confirmed without --cql, the old example confluence search "type=page AND space=MYSPACE" does NOT execute as CQL

🤖 Generated with Claude Code

The search examples showed raw CQL passed as a plain query string
(e.g. `confluence search "type=page AND space=MYSPACE"`), but without
the `--cql` flag this is treated as a literal text search, not a CQL
query. Also document the `--cql` option in the command reference and
use `siteSearch ~` which works more reliably on Confluence Server/DC.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Owner

@pchuri pchuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

Good catch — the existing examples were passing CQL syntax without the --cql flag, which meant they were silently treated as literal text searches. The switch to siteSearch ~ is also a nice improvement for Server/DC environments.

Minor suggestions (non-blocking):

  • L701: The "Search and process results" section is meant to show general usage patterns, so siteSearch ~ "release notes" without the space = "MYSPACE" filter might be simpler and more universal here.
  • The --cql default is listed as false in the options table — for a boolean flag, - or leaving it blank may be more consistent with the other options.

LGTM!

@pchuri pchuri merged commit 86800b5 into pchuri:main Mar 26, 2026
6 checks passed
github-actions bot pushed a commit that referenced this pull request Mar 26, 2026
## [1.27.6](v1.27.5...v1.27.6) (2026-03-26)

### Bug Fixes

* **docs:** correct search examples in SKILL.md to use --cql flag ([#84](#84)) ([86800b5](86800b5))
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 1.27.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants