Skip to content

harrylabsj/openclaw-skill-reading-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ OpenClaw Reading Notes Skill

License Node Version TypeScript OpenClaw Security

Transform reading insights into structured notes - safely and locally

Features β€’ Quick Start β€’ Usage β€’ Security β€’ Contributing

🎯 Overview

The Reading Notes Skill is a secure OpenClaw plugin that expands short reading insights into detailed, structured notes using local templates only. Unlike other skills, it does not call external APIs, access your filesystem, or require any secrets.

Core Philosophy

  • Security First: No external dependencies, no data leaves your machine
  • Privacy by Design: Your reading insights stay private and local
  • Simplicity: Clean, template-based approach without complexity
  • Practicality: Generate actionable notes and reflection prompts

✨ Features

πŸ”’ Security Features

  • βœ… Zero External API Calls: All processing happens locally
  • βœ… No Filesystem Access: Does not read or write to your files
  • βœ… No Secrets Required: No API keys, tokens, or credentials
  • βœ… Transparent Code: All logic visible in source code

πŸ“ Note-Taking Features

  • Insight Expansion: Transform brief insights into detailed notes
  • Multiple Formats: Brief, detailed, and comprehensive note templates
  • Related Concepts: Smart concept mapping for deeper connections
  • Note Prompts: Thoughtful questions to guide your reflection
  • Learning Frameworks: Integrates proven learning methodologies

πŸ› οΈ Technical Features

  • TypeScript Implementation: Type-safe, maintainable code
  • OpenClaw Integration: Seamless integration with OpenClaw ecosystem
  • Local Templates: All content from local, inspectable templates
  • Extensible Design: Easy to add new templates and features

πŸš€ Quick Start

Installation

# Install via ClawHub
clawhub install reading-notes

# Or clone and install locally
git clone https://github.com/harrylabs0913/openclaw-skill-reading-notes.git
cd openclaw-skill-reading-notes
npm install
npm run build

No Configuration Needed!

Unlike other skills, no configuration is required. The skill works immediately with no API keys, environment variables, or file paths to set up.

πŸ“– Usage

Basic Commands

# Expand a reading insight into detailed notes
/reading-notes Today I read about deliberate practice and found it inspiring

# Generate a brief reading note
/reading-brief The importance of spaced repetition in learning

# Get related concepts and note prompts
/reading-related How to build effective learning habits

# Get note-taking prompts only
/reading-prompts Understanding cognitive load theory

Example Output

Input: /reading-notes Today I read about deliberate practice

Output:

*πŸ”’ Security Note: These notes were generated locally without external API calls or data sharing.*

**Detailed Reading Notes:**

**Original Insight:**
Today I read about deliberate practice

**Expanded Analysis:**
This reading touches on meaningful themes relevant to personal and professional growth...

[Full expanded analysis with reflection questions and note-taking tips]

πŸ—οΈ Architecture

Safe Local Processing

Reading Insight β†’ Local Templates β†’ Structured Notes
                    (No external calls)

Skill Structure

src/
β”œβ”€β”€ index.ts          # Main skill implementation
β”œβ”€β”€ templates/        # Local note templates (future)
dist/
β”œβ”€β”€ index.js          # Compiled JavaScript
β”œβ”€β”€ index.d.ts        # TypeScript definitions

Security Model

  • Input: Reading insight (text only)
  • Processing: Local template matching and formatting
  • Output: Structured notes (text only)
  • No: Network calls, file I/O, external dependencies

πŸ”§ Development

Prerequisites

  • Node.js >= 18.0.0
  • OpenClaw >= 2026.3.0
  • TypeScript >= 5.3.2

Setup

git clone https://github.com/harrylabs0913/openclaw-skill-reading-notes.git
cd openclaw-skill-reading-notes
npm install
npm run build

Testing

npm test

Adding New Templates

  1. Edit src/index.ts
  2. Add new template to the templates object
  3. Build and test: npm run build && npm test

🀝 Contributing

Contributions are welcome! Please follow these security principles:

  1. No External Dependencies: Keep the skill local-only
  2. No Filesystem Access: Don't add file I/O operations
  3. Transparent Code: All logic should be inspectable
  4. Template-Based: Add new local templates, not external services

Development Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

πŸ“„ License

MIT License - see LICENSE file for details.

πŸ™ Acknowledgments

  • OpenClaw Team for the amazing platform
  • Digital Partners Team (珍珠, 贝尔, ε“ˆεˆ©, ε–œηΎŠηΎŠ) for collaboration
  • Security Researchers who helped identify and fix vulnerabilities in similar skills

πŸ”— Links

About

OpenClaw skill for expanding reading insights into detailed notes using local templates only

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors