Trim searxng skill to minimal custom-skill layout
This commit is contained in:
Stefano Fiorini
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"version": 1,
|
||||
"registry": "https://clawhub.ai",
|
||||
"slug": "searxng",
|
||||
"installedVersion": "1.0.3",
|
||||
"installedAt": 1773013420514
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to the SearXNG skill will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [1.0.1] - 2026-01-26
|
||||
|
||||
### Changed
|
||||
- **Security:** Changed default SEARXNG_URL from hardcoded private URL to generic `http://localhost:8080`
|
||||
- **Configuration:** Made SEARXNG_URL required configuration (no private default)
|
||||
- Updated all documentation to emphasize configuration requirement
|
||||
- Removed hardcoded private URL from all documentation
|
||||
|
||||
### Security
|
||||
- Eliminated exposure of private SearXNG instance URL in published code
|
||||
|
||||
## [1.0.0] - 2026-01-26
|
||||
|
||||
### Added
|
||||
- Initial release
|
||||
- Web search via local SearXNG instance
|
||||
- Multiple search categories (general, images, videos, news, map, music, files, it, science)
|
||||
- Time range filters (day, week, month, year)
|
||||
- Rich table output with result snippets
|
||||
- JSON output mode for programmatic use
|
||||
- SSL self-signed certificate support
|
||||
- Configurable SearXNG instance URL via SEARXNG_URL env var
|
||||
- Comprehensive error handling
|
||||
- Rich CLI with argparse
|
||||
|
||||
### Features
|
||||
- Privacy-focused (all searches local)
|
||||
- No API keys required
|
||||
- Multi-engine result aggregation
|
||||
- Beautiful formatted output
|
||||
- Language selection support
|
||||
@@ -1,147 +0,0 @@
|
||||
# Publishing SearXNG Skill to ClawdHub
|
||||
|
||||
## ✅ Pre-Publication Verification
|
||||
|
||||
All files present:
|
||||
- [x] SKILL.md (v1.0.1)
|
||||
- [x] README.md
|
||||
- [x] LICENSE (MIT)
|
||||
- [x] CHANGELOG.md
|
||||
- [x] scripts/searxng.py
|
||||
- [x] .clawdhub/metadata.json
|
||||
|
||||
Security:
|
||||
- [x] No hardcoded private URLs
|
||||
- [x] Generic default (http://localhost:8080)
|
||||
- [x] Fully configurable via SEARXNG_URL
|
||||
|
||||
Author:
|
||||
- [x] Updated to: Avinash Venkatswamy
|
||||
|
||||
## 📤 Publishing Steps
|
||||
|
||||
### Step 1: Login to ClawdHub
|
||||
|
||||
```bash
|
||||
clawdhub login
|
||||
```
|
||||
|
||||
This will open your browser. Complete the authentication flow.
|
||||
|
||||
### Step 2: Verify Authentication
|
||||
|
||||
```bash
|
||||
clawdhub whoami
|
||||
```
|
||||
|
||||
Should return your user info if logged in successfully.
|
||||
|
||||
### Step 3: Publish the Skill
|
||||
|
||||
From the workspace root:
|
||||
|
||||
```bash
|
||||
cd ~/clawd
|
||||
clawdhub publish skills/searxng
|
||||
```
|
||||
|
||||
Or from the skill directory:
|
||||
|
||||
```bash
|
||||
cd ~/clawd/skills/searxng
|
||||
clawdhub publish .
|
||||
```
|
||||
|
||||
### Step 4: Verify Publication
|
||||
|
||||
After publishing, you can:
|
||||
|
||||
**Search for your skill:**
|
||||
```bash
|
||||
clawdhub search searxng
|
||||
```
|
||||
|
||||
**View on ClawdHub:**
|
||||
Visit https://clawdhub.com/skills/searxng
|
||||
|
||||
## 📋 What Gets Published
|
||||
|
||||
The CLI will upload:
|
||||
- SKILL.md
|
||||
- README.md
|
||||
- LICENSE
|
||||
- CHANGELOG.md
|
||||
- scripts/ directory
|
||||
- .clawdhub/metadata.json
|
||||
|
||||
It will NOT upload:
|
||||
- PUBLISH.md (this file)
|
||||
- PUBLISHING_CHECKLIST.md
|
||||
- Any .git files
|
||||
- Any node_modules or temporary files
|
||||
|
||||
## 🔧 If Publishing Fails
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Not logged in:**
|
||||
```bash
|
||||
clawdhub login
|
||||
```
|
||||
|
||||
2. **Invalid skill structure:**
|
||||
- Verify SKILL.md has all required fields
|
||||
- Check .clawdhub/metadata.json is valid JSON
|
||||
|
||||
3. **Duplicate slug:**
|
||||
- If "searxng" is taken, you'll need a different name
|
||||
- Update `name` in SKILL.md and metadata.json
|
||||
|
||||
4. **Network issues:**
|
||||
- Check your internet connection
|
||||
- Try again: `clawdhub publish skills/searxng`
|
||||
|
||||
### Get Help
|
||||
|
||||
```bash
|
||||
clawdhub publish --help
|
||||
```
|
||||
|
||||
## 📊 After Publishing
|
||||
|
||||
### Update Notifications
|
||||
|
||||
If you make changes later:
|
||||
|
||||
1. Update version in SKILL.md and metadata.json
|
||||
2. Add entry to CHANGELOG.md
|
||||
3. Run: `clawdhub publish skills/searxng`
|
||||
|
||||
### Manage Your Skill
|
||||
|
||||
**Delete (soft-delete):**
|
||||
```bash
|
||||
clawdhub delete searxng
|
||||
```
|
||||
|
||||
**Undelete:**
|
||||
```bash
|
||||
clawdhub undelete searxng
|
||||
```
|
||||
|
||||
## 🎉 Success!
|
||||
|
||||
Once published, users can install with:
|
||||
|
||||
```bash
|
||||
clawdhub install searxng
|
||||
```
|
||||
|
||||
Your skill will appear:
|
||||
- On ClawdHub website: https://clawdhub.com
|
||||
- In search results: `clawdhub search privacy`
|
||||
- In explore: `clawdhub explore`
|
||||
|
||||
---
|
||||
|
||||
**Ready to publish?** Run `clawdhub login` and then `clawdhub publish skills/searxng`!
|
||||
@@ -1,111 +0,0 @@
|
||||
# ClawdHub Publishing Checklist
|
||||
|
||||
## ✅ Pre-Publication Checklist
|
||||
|
||||
### Required Files
|
||||
- [x] `SKILL.md` - Skill definition with metadata
|
||||
- [x] `README.md` - Comprehensive documentation
|
||||
- [x] `LICENSE` - MIT License
|
||||
- [x] `CHANGELOG.md` - Version history
|
||||
- [x] `scripts/searxng.py` - Main implementation
|
||||
- [x] `.clawdhub/metadata.json` - ClawdHub metadata
|
||||
|
||||
### SKILL.md Requirements
|
||||
- [x] `name` field
|
||||
- [x] `description` field
|
||||
- [x] `author` field
|
||||
- [x] `version` field
|
||||
- [x] `homepage` field
|
||||
- [x] `triggers` keywords (optional but recommended)
|
||||
- [x] `metadata` with emoji and requirements
|
||||
|
||||
### Code Quality
|
||||
- [x] Script executes successfully
|
||||
- [x] Error handling implemented
|
||||
- [x] Dependencies documented (inline PEP 723)
|
||||
- [x] Help text / usage instructions
|
||||
- [x] Clean, readable code
|
||||
|
||||
### Documentation
|
||||
- [x] Clear description of what it does
|
||||
- [x] Prerequisites listed
|
||||
- [x] Installation instructions
|
||||
- [x] Usage examples (CLI + conversational)
|
||||
- [x] Configuration options
|
||||
- [x] Troubleshooting section
|
||||
- [x] Feature list
|
||||
|
||||
### Testing
|
||||
- [x] Tested with target system (SearXNG)
|
||||
- [x] Basic search works
|
||||
- [x] Category search works
|
||||
- [x] JSON output works
|
||||
- [x] Error cases handled gracefully
|
||||
- [ ] Tested on different SearXNG instances (optional)
|
||||
- [ ] Tested with authenticated SearXNG (optional)
|
||||
|
||||
### Metadata
|
||||
- [x] Version number follows semver
|
||||
- [x] Author attribution
|
||||
- [x] License specified
|
||||
- [x] Tags/keywords for discovery
|
||||
- [x] Prerequisites documented
|
||||
|
||||
## ⚠️ Optional Improvements
|
||||
|
||||
### Nice to Have (not blocking)
|
||||
- [ ] CI/CD for automated testing
|
||||
- [ ] Multiple example configurations
|
||||
- [ ] Screenshot/demo GIF
|
||||
- [ ] Video demonstration
|
||||
- [ ] Integration tests
|
||||
- [ ] Authentication support (for private instances)
|
||||
- [ ] Config file support (beyond env vars)
|
||||
- [ ] Auto-discovery of local SearXNG instances
|
||||
|
||||
### Future Enhancements
|
||||
- [ ] Result caching
|
||||
- [ ] Search history
|
||||
- [ ] Favorite searches
|
||||
- [ ] Custom result templates
|
||||
- [ ] Export results to various formats
|
||||
- [ ] Integration with other Clawdbot skills
|
||||
|
||||
## 🚀 Publishing Steps
|
||||
|
||||
1. **Review all files** - Make sure everything is polished
|
||||
2. **Test one more time** - Fresh installation test
|
||||
3. **Version bump if needed** - Update SKILL.md, metadata.json, CHANGELOG.md
|
||||
4. **Git commit** - Clean commit message
|
||||
5. **Submit to ClawdHub** - Follow ClawdHub submission process
|
||||
6. **Monitor feedback** - Be ready to address issues
|
||||
|
||||
## 📝 Current Status
|
||||
|
||||
**Ready for publication:** ✅ YES
|
||||
|
||||
**Confidence level:** High
|
||||
|
||||
**Known limitations:**
|
||||
- Requires a running SearXNG instance (clearly documented)
|
||||
- SSL verification disabled for self-signed certs (by design)
|
||||
- No authentication support yet (acceptable for v1.0.0)
|
||||
|
||||
**Recommended for:** Users who:
|
||||
- Value privacy
|
||||
- Run their own SearXNG instance
|
||||
- Want to avoid commercial search APIs
|
||||
- Need local/offline search capability
|
||||
|
||||
## 🎯 Next Steps
|
||||
|
||||
1. **Publish to ClawdHub** - Skill is ready!
|
||||
2. **Gather user feedback** - Real-world usage
|
||||
3. **Plan v1.1.0** - Authentication support, more features
|
||||
4. **Community contributions** - Accept PRs for improvements
|
||||
|
||||
---
|
||||
|
||||
**Assessment:** This skill is publication-ready! 🎉
|
||||
|
||||
All critical requirements are met, documentation is excellent, and the code works reliably.
|
||||
@@ -1,168 +0,0 @@
|
||||
# SearXNG Search Skill for Clawdbot
|
||||
|
||||
Privacy-respecting web search using your local SearXNG instance.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
**This skill requires a running SearXNG instance.**
|
||||
|
||||
If you don't have SearXNG set up yet:
|
||||
|
||||
1. **Docker (easiest)**:
|
||||
```bash
|
||||
docker run -d -p 8080:8080 searxng/searxng
|
||||
```
|
||||
|
||||
2. **Manual installation**: Follow the [official guide](https://docs.searxng.org/admin/installation.html)
|
||||
|
||||
3. **Public instances**: Use any public SearXNG instance (less private)
|
||||
|
||||
## Features
|
||||
|
||||
- 🔒 **Privacy-focused**: Uses your local SearXNG instance
|
||||
- 🌐 **Multi-engine**: Aggregates results from multiple search engines
|
||||
- 📰 **Multiple categories**: Web, images, news, videos, and more
|
||||
- 🎨 **Rich output**: Beautiful table formatting with result snippets
|
||||
- 🚀 **Fast JSON mode**: Programmatic access for scripts and integrations
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Basic Search
|
||||
```
|
||||
Search "python asyncio tutorial"
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
```
|
||||
Search "climate change" with 20 results
|
||||
Search "cute cats" in images category
|
||||
Search "breaking news" in news category from last day
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
**You must configure your SearXNG instance URL before using this skill.**
|
||||
|
||||
### Set Your SearXNG Instance
|
||||
|
||||
Configure the `SEARXNG_URL` environment variable in your Clawdbot config:
|
||||
|
||||
```json
|
||||
{
|
||||
"env": {
|
||||
"SEARXNG_URL": "https://your-searxng-instance.com"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Or export it in your shell:
|
||||
```bash
|
||||
export SEARXNG_URL=https://your-searxng-instance.com
|
||||
```
|
||||
|
||||
## Direct CLI Usage
|
||||
|
||||
You can also use the skill directly from the command line:
|
||||
|
||||
```bash
|
||||
# Basic search
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "query"
|
||||
|
||||
# More results
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "query" -n 20
|
||||
|
||||
# Category search
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "query" --category images
|
||||
|
||||
# JSON output (for scripts)
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "query" --format json
|
||||
|
||||
# Time-filtered news
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "latest AI news" --category news --time-range day
|
||||
```
|
||||
|
||||
## Available Categories
|
||||
|
||||
- `general` - General web search (default)
|
||||
- `images` - Image search
|
||||
- `videos` - Video search
|
||||
- `news` - News articles
|
||||
- `map` - Maps and locations
|
||||
- `music` - Music and audio
|
||||
- `files` - File downloads
|
||||
- `it` - IT and programming
|
||||
- `science` - Scientific papers and resources
|
||||
|
||||
## Time Ranges
|
||||
|
||||
Filter results by recency:
|
||||
- `day` - Last 24 hours
|
||||
- `week` - Last 7 days
|
||||
- `month` - Last 30 days
|
||||
- `year` - Last year
|
||||
|
||||
## Examples
|
||||
|
||||
### Web Search
|
||||
```bash
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "rust programming language"
|
||||
```
|
||||
|
||||
### Image Search
|
||||
```bash
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "sunset photography" --category images -n 10
|
||||
```
|
||||
|
||||
### Recent News
|
||||
```bash
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "tech news" --category news --time-range day
|
||||
```
|
||||
|
||||
### JSON Output for Scripts
|
||||
```bash
|
||||
uv run ~/clawd/skills/searxng/scripts/searxng.py search "python tips" --format json | jq '.results[0]'
|
||||
```
|
||||
|
||||
## SSL/TLS Notes
|
||||
|
||||
The skill is configured to work with self-signed certificates (common for local SearXNG instances). If you need strict SSL verification, edit the script and change `verify=False` to `verify=True` in the httpx request.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Connection Issues
|
||||
|
||||
If you get connection errors:
|
||||
|
||||
1. **Check your SearXNG instance is running:**
|
||||
```bash
|
||||
curl -k $SEARXNG_URL
|
||||
# Or: curl -k http://localhost:8080 (default)
|
||||
```
|
||||
|
||||
2. **Verify the URL in your config**
|
||||
3. **Check SSL certificate issues**
|
||||
|
||||
### No Results
|
||||
|
||||
If searches return no results:
|
||||
|
||||
1. Check your SearXNG instance configuration
|
||||
2. Ensure search engines are enabled in SearXNG settings
|
||||
3. Try different search categories
|
||||
|
||||
## Privacy Benefits
|
||||
|
||||
- **No tracking**: All searches go through your local instance
|
||||
- **No data collection**: Results are aggregated locally
|
||||
- **Engine diversity**: Combines results from multiple search providers
|
||||
- **Full control**: You manage the SearXNG instance
|
||||
|
||||
## About SearXNG
|
||||
|
||||
SearXNG is a free, open-source metasearch engine that respects your privacy. It aggregates results from multiple search engines while not storing your search data.
|
||||
|
||||
Learn more: https://docs.searxng.org/
|
||||
|
||||
## License
|
||||
|
||||
This skill is part of the Clawdbot ecosystem and follows the same license terms.
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"ownerId": "kn76z88c7kaynewbq2n2cv8831801bfs",
|
||||
"slug": "searxng",
|
||||
"version": "1.0.3",
|
||||
"publishedAt": 1769472992634
|
||||
}
|
||||
Reference in New Issue
Block a user