@openpets/teachable
v1.0.0
Published
Integrate with Teachable platform to manage courses, students, enrollments, lectures, and sales data. Perfect for course creators looking to automate their Teachable school operations.
Maintainers
Readme
Teachable Plugin for OpenPets
Integrate with the Teachable platform to manage your online courses, students, enrollments, lectures, and sales data programmatically.
Features
- Course Management: Create, read, update courses
- Student Management: List students, manage enrollments
- Content Management: Access lectures and course content
- Sales Analytics: Get revenue and enrollment data
- Read-Only Mode: Safe operation with
TEACHABLE_READ_ONLY=true
Setup
1. Get Teachable API Key
- Go to your Teachable school admin
- Navigate to Settings > API Keys
- Click "Create API Key"
- Copy the API key and save it securely
2. Configure Plugin
Set your environment variables:
# Required
TEACHABLE_API_KEY=your_api_key_here
# Optional (auto-detected if not provided)
TEACHABLE_SCHOOL_ID=your_school_id3. Enable Read-Only Mode (Optional)
export TEACHABLE_READ_ONLY=trueAvailable Tools
Connection & Testing
teachable-test-connection- Test API connection and get school info
Course Management
teachable-list-courses- List all courses with filtering optionsteachable-get-course- Get detailed course informationteachable-create-course- Create a new courseteachable-update-course- Update existing course
Student Management
teachable-list-students- List students with filtersteachable-enroll-student- Enroll student in courseteachable-get-enrollments- Get enrollment details
Content & Analytics
teachable-list-lectures- Get course lectures and contentteachable-get-sales-data- Get sales and revenue data
Usage Examples
Basic Course Management
# Test connection
opencode run "test teachable connection"
# List all courses
opencode run "list all teachable courses"
# Get course details
opencode run "get teachable course by ID 123"
# Create new course
opencode run "create new teachable course called 'Introduction to AI'"Student Management
# List students in a course
opencode run "list students in course 123"
# Enroll a new student
opencode run "enroll student [email protected] in course 123"Sales Analytics
# Get sales data for last 30 days
opencode run "get teachable sales data for last 30 days"
# Get sales by course
opencode run "get teachable sales data for course 123"Security & Permissions
Your Teachable API key should have permissions for:
- Courses (read/write)
- Users (read/write for student management)
- Enrollments (read/write)
- Sales (read for analytics)
You can restrict permissions based on your specific needs.
Read-Only Mode
Enable read-only mode to disable all write operations:
- Course creation/updates
- Student enrollments
- Any data modifications
export TEACHABLE_READ_ONLY=trueError Handling
The plugin provides clear error messages for:
- Invalid API keys
- Missing permissions
- Network connectivity issues
- Invalid parameters
Support
- Teachable API Documentation: Available in your Teachable school admin
- Plugin Issues: Report via GitHub issues
- Setup Help: Check FAQ in package configuration
Compatibility
- OpenCode: ✅ Full support
- Claude: ✅ Full support
- Cursor: ✅ Full support
Requires OpenPets SDK v1.0.0+
