Installation¶
Get Tombo up and running in VS Code in just a few minutes.
VS Code Marketplace (Recommended)¶
The easiest way to install Tombo is directly from the VS Code Marketplace:
- Open VS Code
- Press
Ctrl+Shift+X
(Windows/Linux) orCmd+Shift+X
(macOS) to open Extensions - Search for "Tombo"
- Click Install on the official Tombo extension
- Reload VS Code when prompted
- Press
Ctrl+Shift+P
(Windows/Linux) orCmd+Shift+P
(macOS) - Type
Extensions: Install Extensions
- Search for "Tombo"
- Click Install on the official extension
VSIX Installation (Advanced)¶
For nightly (pre-release) versions or offline installation:
Advanced Users Only
Only install VSIX files from trusted sources. The official marketplace installation is recommended for most users.
- Download the VSIX file from the GitHub releases page
- Open VS Code
- Press
Ctrl+Shift+P
(Windows/Linux) orCmd+Shift+P
(macOS) - Type
Extensions: Install from VSIX...
- Select the downloaded VSIX file
- Restart VS Code
System Requirements¶
Minimum Requirements¶
- VS Code: Version 1.74.0 or higher
- Operating System: Windows 10+, macOS 10.15+, or Linux (Ubuntu 18.04+)
- Memory: 4GB RAM minimum, 8GB recommended
- Network: Internet connection for first package lookup (then works offline)
Recommended Environment¶
- VS Code: Latest stable version
- Python: 3.10+ installed (for Python project development, note that <3.10 is fine to use, however it's already the end of the lifecycle.)
- Git: For version control integration
- Node.js: 16+ (if contributing to development)
Verification¶
After installation, verify that Tombo is working correctly:
- Open a Python project with
pyproject.toml
orrequirements.txt
- Look for the Tombo icon in the VS Code status bar (bottom right)
- Hover over a package name in your dependency file
- You should see rich metadata with version information
Installation Complete!
If you see hover information when hovering over package names, Tombo is successfully installed and ready to use!
First Steps¶
Now that Tombo is installed:
- Configure your preferences - Set up PyPI index, logging, and decorations
- Try the quick start guide - Learn the basic features
- Explore examples - See Tombo in action with different project types
Troubleshooting Installation¶
Extension Not Appearing¶
If Tombo doesn't appear in your extensions list:
- Restart VS Code completely
- Check the VS Code output panel for any error messages
- Verify your VS Code version meets the minimum requirements
- Try refreshing the extensions marketplace
Hover Information Not Working¶
If package hover doesn't work:
- Check that you're in a supported file type (
pyproject.toml
,requirements.txt
) - Verify internet connectivity for first-time package lookups
- Check the VS Code output panel for Tombo logs
- Try restarting VS Code
Performance Issues¶
If Tombo feels slow:
- Check your network connection - first lookups require internet
- Wait for initial caching - subsequent requests will be instant
- Clear the cache via VS Code command palette:
Tombo: Clear Cache
Need more help? Check our detailed troubleshooting guide or file an issue.