A premium terminal emulator built on Hyper's robust foundation with aesthetic visuals inspired by Ghosty.
Features β’ Quick Start β’ Documentation β’ Contributing β’ License
Nimbus is a next-generation terminal emulator that combines the power of Hyper's proven architecture with the aesthetic beauty of Ghosty. Built on a solid foundation of modern web technologies, Nimbus delivers a premium terminal experience that is both powerful and visually stunning.
We leverage Hyper's robust terminal emulation engine, extensive plugin ecosystem, and proven stability as our foundation. This gives us a battle-tested core that handles the complex work of terminal emulation.
We've taken inspiration from Ghosty's beautiful design philosophyβethereal transparency, ambient glows, smooth animations, and a carefully crafted color paletteβto create a terminal that's not just functional, but inspiring.
Our vision is to create a terminal emulator that is not only powerful and extensible but also a joy to use. We believe that developers deserve tools that are both functional and beautiful. Nimbus is our attempt to create such a toolβa complete development workspace that developers will love to use every day.
- Hyper Foundation: Built on Hyper's proven terminal emulation engine
- Ghosty-Inspired Design: Ethereal transparency, ambient glows, and carefully crafted color palette
- Smooth Animations: Fluid transitions and micro-interactions that make the terminal feel alive
- Theme System: Browse and apply beautiful themes with one click
- Customizable UI: Full control over fonts, colors, cursor styles, and more
- Fast Rendering: Powered by xterm.js with WebGL acceleration
- Stable Foundation: Built on Hyper's proven terminal emulation engine
- Efficient: Optimized for performance with minimal resource usage
- Cross-Platform: Native experience on Windows, macOS, and Linux
- Plugin System: Robust plugin architecture for custom functionality
- Theme Development: Create and share your own themes
- API Access: Comprehensive API for deep customization
- React Components: Decorate and extend UI components
- Tab Support: Multiple tabs with keyboard shortcuts
- Split Panes: Split terminals horizontally or vertically
- Search: Built-in search functionality
- Ligatures: Font ligature support for better code readability
- Web Links: Clickable URLs in terminal output
- Image Support: Display images directly in the terminal
- JSON Configuration: Simple, human-readable configuration file
- Hot Reload: Changes apply without restart (where possible)
- Profile Support: Multiple profiles for different workflows
- Keyboard Shortcuts: Fully customizable keymaps
- Environment Variables: Per-profile environment configuration
- Node.js 18+ (LTS recommended)
- Yarn package manager
- Git for cloning the repository
-
Clone the repository:
git clone https://github.com/dev-Ninjaa/Nimbus.git cd Nimbus -
Install dependencies:
yarn
-
Start Nimbus:
yarn nimbus
That's it! Nimbus will start with hot reloading enabled.
For more control, run these in separate terminals:
# Terminal 1: Watch and compile
yarn dev
# Terminal 2: Run the app
yarn app# Build optimized version
yarn build
# Create distributable packages
yarn distComprehensive documentation is available in the docs/ directory.
- Installation Guide - Detailed setup instructions
- Quick Start - Apply themes in 3 steps
- Configuration - All configuration options
- Themes - Browse and install beautiful themes
- Plugins - Extend Nimbus functionality
- FAQ - Frequently asked questions
- Troubleshooting - Common issues and solutions
- Architecture - System design and architecture
- Contributing - How to contribute to Nimbus
- Plugin Development - Create your own plugins
- Theme Development - Create custom themes
- API Reference - Complete API documentation
- Tech Stack - Technologies and why we chose them
- Design Philosophy - Our design principles
- Codebase Overview - Comprehensive code walkthrough
- Folder Structure - Project organization
- Testing Guide - How to test Nimbus
- Windows Setup - Fix Windows build issues
- Complete Index - All documentation indexed
Nimbus includes a powerful theme system with curated themes:
- Open π¨ Customize β π¨ Theme Manager
- Browse available themes
- Select and apply your favorite
- Restart Nimbus to see your new theme
Available themes include:
- π£ Gengar - Classic Nimbus aesthetic
- π Cyberpunk City - Neon urban vibes
- π· Neon Grid - Retro-futuristic
- π Purple Nebula - Cosmic space
- π Matrix Code - Digital rain
- π² Dark Forest - Mysterious woods
- π Ocean Waves - Calming seas
Extend Nimbus with plugins:
# Install a plugin
nimbus install <plugin-name>
# Update plugins
# Go to π¨ Customize β π Extensions β π Update PluginsLearn how to create plugins β
Nimbus is built with modern, battle-tested technologies:
| Technology | Purpose | Version |
|---|---|---|
| Electron | Cross-platform desktop framework | 22.3 |
| React | UI component library | 18.2 |
| TypeScript | Type-safe development | 5.4 |
| Redux | State management | 4.2 |
| xterm.js | Terminal emulation | 5.3 |
| Webpack | Module bundler | 5.91 |
| Hyper Core | Terminal foundation | - |
Learn more about our tech stack β
We welcome contributions from the community! Whether you're fixing bugs, adding features, improving documentation, or creating themes and plugins, your help is appreciated.
- Read our Contributing Guide
- Fork the repository
- Create a feature branch
- Make your changes
- Submit a pull request
- Follow our code style (enforced by ESLint)
- Write tests for new features
- Update documentation as needed
- Use conventional commit messages
- π Report bugs - Open an issue with details
- π‘ Suggest features - Share your ideas
- π Improve docs - Help make docs clearer
- π¨ Create themes - Design beautiful themes
- π Build plugins - Extend functionality
- π» Write code - Fix bugs or add features
# Development
yarn nimbus # Run full dev environment (recommended)
yarn dev # Watch and compile (webpack + tsc)
yarn app # Run Electron app
# Building
yarn build # Production build
yarn dist # Create distributable packages
# Testing
yarn test # Run all tests
yarn test:unit # Run unit tests
yarn test:e2e # Run end-to-end tests
yarn lint # Lint code
# Utilities
yarn clean # Clean build artifacts
yarn generate-schema # Generate config schema| Platform | Status | Notes |
|---|---|---|
| Windows | β Fully Supported | Windows 10+ |
| macOS | π§ In Development | Coming soon |
| Linux | π§ In Development | Coming soon |
- Version: 0.8.2-beta
- License: MIT
- Language: TypeScript
- Lines of Code: ~50,000+
- Dependencies: 40+ packages
- Documentation: 18 comprehensive guides
We would like to extend our sincere thanks to:
- Hyper Team - For the solid terminal emulation foundation that powers Nimbus
- Ghosty Community - For the beautiful design aesthetic that inspired our UI
- Kiro - AI assistant that helped build Nimbus. Learn more β
- Electron Team - For the cross-platform framework
- xterm.js Team - For the excellent terminal component
- Vercel - For supporting open source development
Nimbus is MIT licensed.
- Repository: github.com/dev-Ninjaa/-Nimbus
- Documentation: Complete documentation
- Contributing: How to contribute
- GitHub Discussions - Ask questions and share ideas
- Pull Requests - Contribute code and documentation
Our long-term vision includes:
- GUI Application Integration - Run GUI apps within terminal tabs
- Visual Git Management - Integrated Git UI
- Database Management - Built-in database tools
- Cloud Sync - Synchronize configurations across devices
- Collaboration Features - Share sessions with team members
- AI Integration - AI-powered suggestions and automation
If you find Nimbus useful, please consider:
- β Starring this repository
- π Reporting bugs you encounter
- π‘ Suggesting features you'd like to see
- π Contributing code or documentation
- π¨ Creating themes for the community
- π Building plugins to extend functionality
Built with β€οΈ by developers, for developers
Get Started β’ Documentation β’ Contribute