\r \r

Gety Local Search\r

\r

Overview\r

\r To search local files and documents indexed by Gety, use the gety CLI. Gety is an AI-powered local file search engine that supports semantic search across all indexed content on the user's machine.\r \r

Quick Start\r

\r To perform a basic search:\r \r

gety search "\x3Cquery>"\r
```\r
\r
To get structured JSON output (useful for further processing):\r
\r
```bash\r
gety search "\x3Cquery>" --json\r
```\r
\r
## Core Operations\r
\r
### Searching Documents\r
\r
To search indexed content, use `gety search` with the user's query. Key options:\r
\r
| Option | Description |\r
| --- | --- |\r
| `-n, --limit \x3Cn>` | Max results to return (default: 10) |\r
| `--offset \x3Cn>` | Pagination offset (default: 0) |\r
| `-c, --connector \x3Cname>` | Filter by connector name (repeatable or comma-separated) |\r
| `-e, --ext \x3Cext>` | Filter by file extension (e.g. `pdf,docx`) |\r
| `--match-scope \x3Cscope>` | Filter by match type: `title`, `content`, `semantic` |\r
| `--sort-by \x3Cfield>` | Sort by `default` or `update_time` |\r
| `--sort-order \x3Cdir>` | `ascending` or `descending` |\r
| `--update-time-from \x3Ciso8601>` | Filter by update time (from) |\r
| `--update-time-to \x3Ciso8601>` | Filter by update time (to) |\r
| `--no-semantic-search` | Disable semantic search (enabled by default) |\r
\r
**Examples:**\r
\r
```bash\r
# Basic search\r
gety search "meeting notes"\r
\r
# Search with more results and pagination\r
gety search "roadmap" -n 20 --offset 20\r
\r
# Filter by connector and file type\r
gety search "security review" -c "Folder: Work" -e pdf,docx\r
\r
# Sort by most recently updated\r
gety search "design system" --match-scope title,content --sort-by update_time --sort-order descending\r
\r
# JSON output for processing\r
gety search "project plan" --json\r
```\r
\r
### Fetching a Specific Document\r
\r
To retrieve detailed content of a specific document by its connector ID and document ID:\r
\r
```bash\r
gety doc \x3Cconnector_id> \x3Cdoc_id>\r
gety doc \x3Cconnector_id> \x3Cdoc_id> --json\r
```\r
\r
### Managing Connectors\r
\r
Connectors define which local directories Gety indexes.\r
\r
```bash\r
# List all available connectors\r
gety connector list\r
\r
# Add a new directory to index\r
gety connector add /path/to/folder --name "Folder: Work"\r
\r
# Remove a connector by ID\r
gety connector remove folder_1\r
```\r
\r
## Workflow\r
\r
1. **Receive the user's search request** — identify the query intent (file name, content topic, file type, date range, etc.)\r
2. **Run `gety connector list`** if unsure which connectors exist, to understand the indexed scope\r
3. **Run `gety search "\x3Cquery>"`** with appropriate options based on the user's intent\r
4. **Present results clearly** — show file name, location, and a brief description of matched content\r
5. **Fetch full content if needed** — use `gety doc \x3Cconnector_id> \x3Cdoc_id>` when the user needs to read the document\r
6. **Handle no-results gracefully** — suggest broadening the query, checking connector coverage, or verifying the index is up to date\r
7. **Handle exit codes** — check the process exit code after each command:\r
   - `69`: Gety is not running — ask the user to start the Gety desktop app and retry\r
   - `77`: Quota exceeded — inform the user and suggest retrying later\r
   - `2`: Invalid arguments — check command syntax with `gety search --help`\r
   - `1`: General error — report the error message to the user\r
   - Full exit code reference: `references/gety_cli.md`\r
\r
## References\r
\r
Full CLI documentation is available in `references/gety_cli.md`.\r