Skip to content

Document discover --search #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohanLorenzo merged 1 commit into from
Jun 12, 2026
Merged

Document discover --search #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## [Unreleased]

### Features
- `discover --search`/`-q`: full-text search across all queries and dashboards (with `--limit`, default 50)

## [0.7.0] - 2026-05-27

### Features
Expand Down
5 changes: 3 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Redash CLI that gives Claude Code direct access to sql.telemetry.mozilla.org —

## Quick Reference

**Commands**: `discover` `init` `fetch` `deploy` `execute` `data-sources` `archive` `unarchive` `dashboards`
**Commands**: `discover [--search TEXT] [--limit N]` `init` `fetch` `deploy` `execute` `data-sources` `archive` `unarchive` `dashboards`
**Env Vars**: `REDASH_API_KEY` (required), `REDASH_URL` (optional, defaults to sql.telemetry.mozilla.org)

## Key Constraints
Expand All @@ -26,7 +26,7 @@ src/
├── models.rs # Data structures
└── commands/
├── mod.rs # OutputFormat enum
├── discover.rs # List all resources
├── discover.rs # List own queries or full-text search queries + dashboards
├── init.rs # Create directory
├── fetch.rs # Download queries, slugify()
├── deploy.rs # Upload changes
Expand All @@ -48,6 +48,7 @@ src/
## API Client (api.rs)

**Query**: list_my_queries, get_query, fetch_all_queries, create_query, create_or_update_query
**Search**: search_queries(q, limit), search_dashboards(q, limit); `base_url()` accessor
**Visualization**: create_visualization, update_visualization
**Execution**: refresh_query, poll_job, get_query_result, execute_query_with_polling
**Data Source**: list_data_sources, get_data_source, get_data_source_schema
Expand Down
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ stmo-cli init

4. Discover available queries:
```bash
stmo-cli discover
stmo-cli discover # List your own queries
stmo-cli discover --search "firefox dau" # Full-text search queries + dashboards
```

5. Fetch specific queries:
Expand All @@ -77,9 +78,10 @@ stmo-cli fetch 123 456 789
### Fetch Queries from Redash

```bash
stmo-cli fetch --all # Fetch all tracked queries
stmo-cli fetch 123 456 789 # Fetch specific queries
stmo-cli discover # List available queries
stmo-cli fetch --all # Fetch all tracked queries
stmo-cli fetch 123 456 789 # Fetch specific queries
stmo-cli discover # List your own queries
stmo-cli discover --search "firefox dau" # Full-text search queries + dashboards (--limit, default 50)
```

This creates/updates:
Expand Down
6 changes: 3 additions & 3 deletions templates/init/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This repository contains version-controlled Redash queries and dashboards manage
## Quick Reference

**Install**: `cargo install stmo-cli`
**Commands**: `discover` `fetch` `deploy` `execute` `data-sources` `archive` `unarchive` `dashboards`
**Commands**: `discover [--search TEXT] [--limit N]` `fetch` `deploy` `execute` `data-sources` `archive` `unarchive` `dashboards`
**File Naming**: `queries/{id}-{slug}.sql` + `queries/{id}-{slug}.yaml`, `dashboards/{id}-{slug}.yaml`
**Env Vars**: `REDASH_API_KEY` (required), `REDASH_URL` (optional, defaults to sql.telemetry.mozilla.org)

Expand All @@ -17,7 +17,7 @@ This repository contains version-controlled Redash queries and dashboards manage

1. **Find data sources**: `stmo-cli data-sources`
2. **Explore schema**: `stmo-cli data-sources <id> --schema`
3. **Discover queries**: `stmo-cli discover`
3. **Discover queries**: `stmo-cli discover --search "<keyword>"` (or bare `stmo-cli discover` to list your own queries)
4. **Fetch query**: `stmo-cli fetch <id>` → read `queries/<id>-*.sql`
5. **Execute**: `stmo-cli execute <id> --format table`
6. **Clean up**: `stmo-cli archive <id>` (MANDATORY)
Expand All @@ -27,7 +27,7 @@ To restore: `stmo-cli unarchive <id> && stmo-cli fetch <id>`
## Commands

### Queries
**discover**: List all queries (IDs + names)
**discover**: List your own queries (IDs + names). With `--search TEXT` (short: `-q`), performs a full-text search across all queries and dashboards; `--limit N` caps results per section (default 50)
**fetch**: Download queries (`--all` for tracked, or `<ids>`)
**deploy**: Upload changes (no args = git-changed files only or all if not in a git repo, `--all` for everything, or `<ids>`)
**execute**: Run query (`--param key=val`, `--format table|json`, `--interactive`)
Expand Down
Loading