Prerequisites
Before you begin, ensure you have:- Python 3.8+ or Rust 1.70+ (depending on your preferred implementation)
- pip (for Python) or cargo (for Rust)
- Basic familiarity with async programming (for Python) or Rust async (for Rust)
Don’t worry if you’re new to async programming! FastSkill handles most of the complexity for you.
Choose Your Implementation
FastSkill offers implementations in multiple languages. Choose the one that best fits your project:- CLI (Recommended)
- Python SDK
- Rust
Command-line interface for managing skills with semantic search. This is the primary way to use FastSkill.This command will:This builds the semantic search index using OpenAI embeddings.
1
Install FastSkill
Verify installation:
fastskill --help2
Initialize your project
- Prompt for your OpenAI API key
- Create
.fastskill.yamlconfiguration - Set up
.skills/directory structure - Create an example skill
3
Index your skills
4
Search for skills
Your First Skill
Now that you have FastSkill running, let’s create your first skill. Skills are the building blocks that define capabilities for AI agents.1
Create a skill definition
Create a new file
my-skill.json:my-skill.json
2
Register the skill
register-skill.py
3
Test skill discovery
test-discovery.py
Configuration Options
Customize FastSkill for your environment:What’s Next?
Congratulations! You now have FastSkill up and running with your first skill. Here are some next steps:
Skill Development
Learn how to create more complex skills with advanced capabilities.
Integration Guide
Connect FastSkill to popular AI agent frameworks.
API Reference
Explore the complete API reference for advanced usage.
Performance Tuning
Optimize FastSkill for production workloads.
Troubleshooting
Common Issues
Common Issues
ImportError in Python: Make sure you have Python 3.8+ and run
pip install fastskill.Rust compilation errors: Ensure you have Rust 1.70+ installed with
rustup install stable.No skills found: Check your skill storage path and ensure skill files have the correct format.
Getting Help
Getting Help
- 📖 Documentation: Browse the complete documentation
- 🐛 Issues: Report bugs on GitHub
- 💬 Discussions: Join the community on GitHub Discussions
Need more help? Check out the installation guide for detailed setup instructions or the examples section for more code samples.