https://github.com/kerim/raycast-logseq-search
Search your Logseq DB graphs directly from Raycast
https://github.com/kerim/raycast-logseq-search
logseq productivity raycast raycast-extension search typescript
Last synced: 4 months ago
JSON representation
Search your Logseq DB graphs directly from Raycast
- Host: GitHub
- URL: https://github.com/kerim/raycast-logseq-search
- Owner: kerim
- License: mit
- Created: 2025-11-14T06:21:56.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-12-16T03:31:52.000Z (6 months ago)
- Last Synced: 2026-01-20T13:57:45.078Z (4 months ago)
- Topics: logseq, productivity, raycast, raycast-extension, search, typescript
- Language: TypeScript
- Size: 162 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Logseq Search - Raycast Extension
Search your Logseq DB graphs directly from Raycast.
## Features
- 🔍 **Real-time search** - Search as you type with intelligent debouncing
- 📊 **Graph selector** - Automatic detection and dropdown selection of available graphs
- 💾 **Remembers selection** - Your last selected graph is saved between sessions
- 🚀 **Fast** - Direct HTTP API integration with Logseq
- 🔗 **Deep linking** - Open pages directly in Logseq
- 📋 **Quick actions** - Copy page links and titles
- ⚡ **No Logseq Desktop required** - Works with Logseq CLI and DB graphs
## Screenshots
*Search interface with graph selector dropdown*
## Prerequisites
### Required
1. **[Raycast](https://www.raycast.com/)** - Download and install Raycast
2. **[Logseq HTTP Server](https://github.com/kerim/logseq-http-server)** - HTTP server for Logseq CLI
Follow the installation guide in the [logseq-http-server repository](https://github.com/kerim/logseq-http-server)
3. **Logseq DB Graph** - The extension works with Logseq DB (database) graphs only
Verify your graphs:
```bash
logseq list
```
## Installation
### Option 1: Install from Source
1. Clone this repository:
```bash
git clone https://github.com/kerim/raycast-logseq-search.git
cd raycast-logseq-search
```
2. Install dependencies:
```bash
npm install
```
3. Build the extension:
```bash
npm run build
```
4. Import in Raycast:
- Open Raycast Settings (⌘,)
- Go to Extensions tab
- Click "+" → "Add Local Extension"
- Select the `raycast-logseq-search` folder
- Click "Add"
### Option 2: Development Mode
For development or testing:
```bash
git clone https://github.com/kerim/raycast-logseq-search.git
cd raycast-logseq-search
npm install
npm run dev
```
This opens Raycast with the extension loaded in development mode.
## Usage
### First Time Setup
1. **Start the Logseq HTTP Server:**
```bash
cd /path/to/logseq-http-server
python3 logseq_server.py
```
2. **Open Raycast** (⌘ Space)
3. **Search for "Search Logseq"**
4. **Select your graph** from the dropdown (top-right)
5. **Start searching!** Your graph selection will be remembered
### Daily Use
1. Open Raycast (⌘ Space)
2. Type "Search Logseq"
3. Start typing your search query
4. Press Enter to open in Logseq
### Keyboard Shortcuts
- **Enter** - Open page in Logseq
- **⌘ C** - Copy page link to clipboard
- **⌘ ⇧ C** - Copy page title to clipboard
- **⌘ ,** - Open extension preferences
## Configuration
The extension has minimal configuration needed. All settings are optional:
- **Default Graph Name** - Optional default graph for first launch
- **Server URL** - HTTP server URL (default: `http://localhost:8765`)
- **Max Results** - Maximum search results to display (default: `20`)
Access preferences: Raycast → Extensions → Logseq Search → Configure
## Dependencies
### Extension Dependencies
- `@raycast/api` (^1.98.2) - Raycast extension API
- `@raycast/utils` (^1.17.0) - Raycast utilities
### External Dependencies
- **[Logseq HTTP Server](https://github.com/kerim/logseq-http-server)** - HTTP API server for Logseq CLI
- **[Logseq CLI](https://www.npmjs.com/package/@logseq/cli)** - Official Logseq command-line interface
- **[jet](https://github.com/borkdude/jet)** - EDN to JSON converter (required by HTTP server)
## How It Works
```
┌─────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ Raycast │ ◄─────► │ This Extension │ ◄─────► │ HTTP Server │
│ UI │ User │ (TypeScript) │ REST │ (Python) │
└─────────────┘ Input └──────────────────┘ API └─────────────────┘
│
▼
┌─────────────────┐
│ Logseq CLI │
│ DB Graphs │
└─────────────────┘
```
1. Extension fetches available graphs from HTTP server
2. User selects graph and types search query
3. Extension sends search request to HTTP server
4. HTTP server queries Logseq CLI
5. Results are displayed in Raycast
6. User opens page using `logseq://` URL scheme
## API Endpoints Used
The extension communicates with these HTTP server endpoints:
- `GET /list` - Fetch available Logseq graphs
- `GET /search?q={query}&graph={graph}` - Search pages in a graph
## Troubleshooting
### "Cannot connect to Logseq HTTP server"
**Cause:** HTTP server is not running
**Solution:**
```bash
cd /path/to/logseq-http-server
python3 logseq_server.py
```
Verify server is running:
```bash
curl http://localhost:8765/health
```
### "No graphs available" in dropdown
**Possible causes:**
- HTTP server is not running
- No Logseq DB graphs exist
- Incorrect server URL in preferences
**Solutions:**
1. Check server is running: `curl http://localhost:8765/list`
2. Verify graphs exist: `logseq list`
3. Check server URL in extension preferences
### Extension not appearing in Raycast
**Solution:**
1. Rebuild the extension: `npm run build`
2. Restart Raycast: ⌘ Q then reopen
3. Check Extensions tab in Raycast settings
## Development
### Project Structure
```
raycast-logseq-search/
├── src/
│ └── search-logseq.tsx # Main extension component
├── assets/
│ └── extension-icon.png # Extension icon
├── package.json # Extension manifest
├── tsconfig.json # TypeScript configuration
├── README.md # This file
└── .gitignore # Git ignore rules
```
### Build Commands
```bash
# Development mode (hot reload)
npm run dev
# Production build
npm run build
# Lint code
npm run lint
# Fix lint issues
npm run fix-lint
```
### Contributing
Contributions are welcome! Please:
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run `npm run lint` and fix any issues
5. Submit a pull request
## Related Projects
- **[logseq-http-server](https://github.com/kerim/logseq-http-server)** - HTTP API server for Logseq CLI (required dependency)
- **[logseq-db-sidekick](https://github.com/kerim/logseq-db-sidekick)** - Browser extension for Logseq search
## Changelog
### v1.1.0 (2025-XX-XX)
**Fixed:**
- **Graph Selection Persistence**: Fixed issue where saved graph selection was reset to first graph on extension reload
- The `List.Dropdown` component was calling `onChange` with the first graph during initialization
- Added robust detection to ignore spurious Dropdown initialization calls while preserving user selections
**Technical Details:**
- Added `firstGraph` state to track the first graph in the list
- Enhanced `handleGraphChange` with logic to detect and ignore Dropdown initialization calls
- Maintains backward compatibility and all existing functionality
### v1.0.0 (Initial Release)
Initial release with core functionality:
- Real-time search across Logseq DB graphs
- Graph selection dropdown with automatic detection
- Deep linking to Logseq using `logseq://` URLs
- Configurable server URL and max results
## License
MIT License - see [LICENSE](LICENSE) file for details
## Author
Created by [Kerim Friedman](https://github.com/kerim)
## Acknowledgments
- Built with [Raycast API](https://developers.raycast.com/)
- Uses [Logseq HTTP Server](https://github.com/kerim/logseq-http-server)
- Powered by [Logseq CLI](https://www.npmjs.com/package/@logseq/cli)