Thanks to visit codestin.com
Credit goes to github.com

Skip to content

dev-Ninjaa/-nImbus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Nimbus Logo

Nimbus

Electron React TypeScript Webpack xterm.js

Version License Platform GitHub Stars

A premium terminal emulator built on Hyper's robust foundation with aesthetic visuals inspired by Ghosty.

Features β€’ Quick Start β€’ Documentation β€’ Contributing β€’ License


🎯 About Nimbus

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.

Built on Hyper

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.

Inspired by Ghosty

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

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.

✨ Features

🎨 Aesthetic Excellence

  • 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

⚑ Performance & Reliability

  • 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

πŸ”Œ Extensibility

  • 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

πŸ’» Developer Features

  • 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

βš™οΈ Configuration

  • 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

πŸš€ Quick Start

Prerequisites

  • Node.js 18+ (LTS recommended)
  • Yarn package manager
  • Git for cloning the repository

Installation

  1. Clone the repository:

    git clone https://github.com/dev-Ninjaa/Nimbus.git
    cd Nimbus
  2. Install dependencies:

    yarn
  3. Start Nimbus:

    yarn nimbus

That's it! Nimbus will start with hot reloading enabled.

Alternative Development Setup

For more control, run these in separate terminals:

# Terminal 1: Watch and compile
yarn dev

# Terminal 2: Run the app
yarn app

Building for Production

# Build optimized version
yarn build

# Create distributable packages
yarn dist

πŸ“– Documentation

Comprehensive documentation is available in the docs/ directory.

πŸš€ Getting Started

πŸ“š User Guides

  • Themes - Browse and install beautiful themes
  • Plugins - Extend Nimbus functionality
  • FAQ - Frequently asked questions
  • Troubleshooting - Common issues and solutions

πŸ‘¨β€πŸ’» Developer Documentation

πŸ“¦ Project Information

πŸ”§ Resources

🎨 Theme System

Nimbus includes a powerful theme system with curated themes:

  1. Open 🎨 Customize β†’ 🎨 Theme Manager
  2. Browse available themes
  3. Select and apply your favorite
  4. 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

Learn more about themes β†’

πŸ”Œ Plugin System

Extend Nimbus with plugins:

# Install a plugin
nimbus install <plugin-name>

# Update plugins
# Go to 🎨 Customize β†’ πŸ”Œ Extensions β†’ πŸ”„ Update Plugins

Learn how to create plugins β†’

πŸ› οΈ Tech Stack

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 β†’

🀝 Contributing

We welcome contributions from the community! Whether you're fixing bugs, adding features, improving documentation, or creating themes and plugins, your help is appreciated.

How to Contribute

  1. Read our Contributing Guide
  2. Fork the repository
  3. Create a feature branch
  4. Make your changes
  5. Submit a pull request

Development Guidelines

  • Follow our code style (enforced by ESLint)
  • Write tests for new features
  • Update documentation as needed
  • Use conventional commit messages

Ways to Contribute

  • πŸ› 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

πŸ“œ Scripts

# 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 Support

Platform Status Notes
Windows βœ… Fully Supported Windows 10+
macOS 🚧 In Development Coming soon
Linux 🚧 In Development Coming soon

πŸ“Š Project Stats

  • Version: 0.8.2-beta
  • License: MIT
  • Language: TypeScript
  • Lines of Code: ~50,000+
  • Dependencies: 40+ packages
  • Documentation: 18 comprehensive guides

πŸ™ Acknowledgments

We would like to extend our sincere thanks to:

πŸ“„ License

Nimbus is MIT licensed.

πŸ”— Links

πŸ’¬ Community

  • GitHub Discussions - Ask questions and share ideas
  • Pull Requests - Contribute code and documentation

🚧 Future Roadmap

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

⭐ Show Your Support

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

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published