A comprehensive Visual Studio Code extension for exploring and managing your Keboola Connection projects. Browse storage buckets and tables, manage configurations across branches, and monitor job execution - all from within VS Code.
- Bucket Management: Browse all storage buckets in your project
- Table Details: View table schemas, metadata, and data previews
- Interactive Navigation: Hierarchical tree view with expandable buckets
- Quick Access: Direct links to Keboola Connection web interface
- Branch Navigation: Switch between development branches
- Component Organization: Browse components by category (extractors, writers, transformations, etc.)
- Configuration Details: View and edit component configurations
- Multi-Branch Support: Manage configurations across different branches
- Real-Time Status: Monitor running, failed, and completed jobs
- Job Details: Comprehensive job information including logs and metadata
- Filtering: View jobs by status, component, or time period
- Quick Actions: Direct access to job details and related configurations
- Visual Studio Code (version 1.60.0 or higher)
- Valid Keboola Connection project with API access
- Storage API token with appropriate permissions
- Download the latest
.vsix
file from thebuilds/
directory - Open VS Code
- Go to Extensions view (
Ctrl+Shift+X
orCmd+Shift+X
) - Click the "..." menu and select "Install from VSIX..."
- Select the downloaded
.vsix
file
- Clone this repository
- Install dependencies:
npm install
- Compile TypeScript:
npm run compile
- Press
F5
to run in Extension Development Host
- Open VS Code Settings (
Ctrl+,
orCmd+,
) - Search for "Keboola"
- Configure the following settings:
- Keboola URL: Your Keboola Connection URL (e.g.,
https://connection.keboola.com
) - Storage API Token: Your Storage API token
- Default Branch: Default branch ID for configurations (optional)
- Keboola URL: Your Keboola Connection URL (e.g.,
Alternatively, use the Command Palette:
- Press
Ctrl+Shift+P
(orCmd+Shift+P
) - Type "Keboola: Configure Settings"
- Follow the setup wizard
- After installation, open the Keboola Explorer panel in the Activity Bar
- Configure your connection settings (see Configuration section above)
- The extension will automatically load your project data
- Expand buckets to view tables
- Click on tables to view details in the panel
- Use the refresh button to update bucket/table lists
- Access table data and metadata through detail panels
- Switch between branches using the branch selector
- Browse components organized by type
- View configuration details and parameters
- Access recent jobs for each configuration
- Monitor job status in real-time
- Filter jobs by status (Running, Failed, Finished)
- View detailed job information including logs
- Navigate from jobs to their source configurations
├── builds/ # VSIX packages for different versions
├── src/
│ ├── jobs/ # Jobs monitoring functionality
│ │ ├── jobsApi.ts # Queue API client
│ │ ├── JobsTreeProvider.ts # Jobs tree view provider
│ │ └── JobDetailPanel.ts # Job detail panels
│ ├── BranchDetailPanel.ts # Branch information panels
│ ├── BucketDetailPanel.ts # Bucket detail panels
│ ├── ConfigurationDetailPanel.ts # Configuration panels
│ ├── ConfigurationsPanel.ts # Configuration management panels
│ ├── ConfigurationsTreeProvider.ts # Configurations tree provider
│ ├── KeboolaTreeProvider.ts # Main tree provider
│ ├── TableDetailPanel.ts # Table detail panels
│ ├── extension.ts # Main extension entry point
│ ├── keboolaApi.ts # Storage API client
│ └── settings.ts # Settings management
├── package.json # Extension manifest
└── README.md # This file
npm install # Install dependencies
npm run compile # Compile TypeScript
npm run watch # Watch mode for development
- Open the project in VS Code
- Press
F5
to launch Extension Development Host - Test the extension in the new window
npm install -g vsce
vsce package # Creates .vsix file
This extension integrates with several Keboola APIs:
- Storage API: Buckets, tables, and project information
- Components API: Component configurations and metadata
- Queue API: Job monitoring and execution details
- Management API: Branch and project management
- API tokens are stored securely in VS Code's extension storage
- Tokens are masked in debug logs for security
- All API communications use HTTPS
- v3.1.2: Unified authentication system across all sections
- v3.1.1: Added comprehensive debug logging
- v3.1.0: Introduced Jobs monitoring system
- v3.0.0: Added Configurations management with branch support
- v2.x: Storage Explorer functionality
"Unauthorized" errors:
- Verify your Storage API token is valid and has appropriate permissions
- Check that the Keboola URL is correct
- Ensure you're using the correct project token
Extension not loading:
- Restart VS Code
- Check the Output panel for error messages
- Verify all required settings are configured
Jobs not showing:
- Ensure your token has access to the Queue API
- Check that the project has job history
- Try refreshing the Jobs view
Enable debug logging in settings to troubleshoot issues:
- Open VS Code Settings
- Search for "Keboola Debug"
- Enable debug logging
- Check the Output panel for detailed logs
This project is licensed under the MIT License - see the LICENSE file for details.
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
Explore your Keboola projects efficiently with VS Code! 🚀