Quick Start Guide
This guide will help you get started with Lemo quickly after installation. We'll cover the basics of using Lemo for common development tasks.
Initial Setup
- Ensure Lemo is installed (see Installation Guide)
- Set up your API key as an environment variable:
# Choose one: export ANTHROPIC_API_KEY=your-key-here export OPENAI_API_KEY=your-key-here export GROQ_API_KEY=your-key-here
Starting Lemo
Using the Main UI
npx lemo-ui
Using the Terminal UI
lemo-tui
Basic Usage
1. Opening a Project
Navigate to your project directory and start Lemo there. The agent will only have access to files in this directory, ensuring security and focus.
2. Common Tasks
Code Exploration
- Ask Lemo to explain code: "Can you explain how this module works?"
- Navigate through files: "Show me the implementation of X function"
- Understand architecture: "Explain the project structure"
Writing Code
- Request new features: "Add a function that does X"
- Fix bugs: "Help me fix this error"
- Write tests: "Create a test suite for this module"
Configuration
- Set up project: "Help me set up the configuration for X"
- Modify settings: "Update the settings to enable Y"
3. Best Practices
- Be specific in your requests
- Provide context when needed
- Review suggested changes before applying
- Use version control for safety
Example Interactions
Bug Fixing
You: "I'm getting a TypeError in my authentication module"
Lemo: *Analyzes code and suggests fixes*
You: "Apply the suggested fix"
Lemo: *Makes changes and verifies*
Feature Addition
You: "Add input validation to the user registration form"
Lemo: *Suggests implementation*
You: "Looks good, implement it"
Lemo: *Adds the feature and tests*
Tips for Success
Clear Communication
- Be specific about what you want to achieve
- Provide necessary context
- Ask for clarification if needed
Iterative Development
- Start with small, focused tasks
- Review and refine solutions
- Build complexity gradually
Safety First
- Work in a version-controlled environment
- Review changes before applying
- Keep backups of important files
Effective Collaboration
- Use Lemo as a pair programmer
- Ask for explanations when needed
- Learn from suggested solutions
Keyboard Shortcuts
Terminal UI
- Ctrl+C: Interrupt current operation
- Ctrl+D: Exit Lemo
- Arrow keys: Navigate history
Main UI
- Command palette: Access common actions
- File navigation: Browse project structure
- Quick commands: Perform frequent tasks
Next Steps
- Explore the Features Overview
- Learn about Advanced Usage
- Check out Best Practices
- Review Configuration Options
Getting Help
If you encounter issues:
- Check the Troubleshooting Guide
- Review common solutions in our documentation
- Reach out to the community on Twitter @lemoai_sh
- File an issue on GitHub if needed
Remember: Lemo is designed to be your coding companion. Take time to explore its capabilities and find the workflow that works best for you.