Nebula CLI Documentation
Welcome to the official documentation for Nebula. Nebula is a collaborative Version Control System built to simplify project management and software collaboration. Instead of dealing with complicated repositories and branching strategies, Nebula organizes development around Projects and Updates, making collaboration straightforward for both beginners and experienced developers.
Welcome to Nebula
Nebula is designed to make collaborative software development simple. Whether you are creating a personal project or working with a large team, Nebula provides an intuitive command-line interface that lets you create projects, publish updates, invite collaborators and synchronize changes with only a few commands. Unlike traditional version control systems, Nebula focuses on developer productivity by removing unnecessary complexity while keeping project history organized and accessible.
Installation
Install the latest version of Nebula using pip.
pip install nebula
Once installation is complete, verify it by opening the help menu.
neb --help
Quick Command Reference
The table below lists every command available in Nebula.
| Command | Description |
|---|---|
| neb signup | Create a new Nebula account. |
| neb login | Login to an existing account. |
| neb startproject | Create a new project. |
| neb startupdate | Start a new update. |
| neb workon <update> | Continue working on a selected update. |
| neb listupdates | Show every update inside the project. |
| neb history | View the history of all updates. |
| neb addcollab <email> | Invite a collaborator. |
| neb joinproject | Join a project using the project code and password. |
| neb install <update> | Download one specific update. |
| neb sync | Synchronize the complete project. |
| neb --help | Display every available command. |
neb signup
The neb signup command is used to create a brand-new Nebula account. Every new user must create an account before they can create projects, collaborate with teammates, or publish updates. During signup, Nebula will ask for your:
- Email Address
- Username
- Password
Once the information is entered, your account is securely created and ready for use.
$ neb signup Email : john@example.com Username : John Password : ******** ✔ Account created successfully.
Tip
You only need to create an account once. After signing up, use neb login whenever you want to access your projects.
neb login
The neb login command allows an existing Nebula user to access their account. Logging in connects your local CLI to your Nebula account so that you can create projects, publish updates, invite collaborators and synchronize your work.
$ neb login Email : john@example.com Password : ******** ✔ Login successful.
After logging in, Nebula remembers your account on the current machine until you log out.
neb startproject
This command creates a completely new Nebula project. A project acts as the central workspace where all updates, collaborators and project history are stored. When you execute this command, Nebula uploads the current project directory and initializes it as a new cloud project.
When should I use it?
- Starting a new application
- Beginning a university project
- Creating an open-source project
- Creating a personal project
$ neb startproject Project Name : Nebula Chat ✔ Project created successfully. Project Code : A73K-29PQ Project Password : 4JLM92
Important
Keep your Project Code and Project Password safe. Anyone with these credentials can join your project if they are invited by the owner.
neb startupdate
Projects in Nebula evolve through Updates. Instead of directly modifying the main project, every new feature, bug fix or improvement should begin as its own update. This keeps development organized and allows multiple developers to work independently.
Examples of Updates
- User Authentication
- Dark Mode
- Payment Integration
- Bug Fixes
- Performance Improvements
$ neb startupdate Update Name : Authentication System ✔ Update created successfully.
Once an update has been created, you can switch to it using neb workon.
Working with Updates
One of Nebula's biggest advantages is that every feature can be developed independently. Instead of editing the main project directly, developers create updates and switch between them whenever required. This keeps work organized and prevents different features from interfering with one another.
neb workon {update_name}
After creating an update, you'll usually want to continue developing it. The neb workon command lets you switch to any existing update inside your project. Think of an update as a separate workspace where one feature or bug fix can be developed independently from the rest of the project. This makes it easy for multiple developers to work simultaneously without overwriting each other's progress.
Syntax
neb workon {update_name}
Example
$ neb workon Authentication ✔ Switched to update "Authentication" Workspace loaded successfully.
Typical Use Cases
- Continue developing an unfinished feature.
- Fix a bug reported by your team.
- Review another developer's work.
- Resume work from another computer.
Tip
You can switch between updates whenever you want. Every update maintains its own progress independently.
neb listupdates
As projects grow, dozens of updates may exist at the same time. The neb listupdates command displays every update that belongs to the current project. Both published and unpublished updates are shown so developers always know what work has already been completed and what is still in progress.
Information Displayed
- Update Name
- Status
- Creator
- Date Created
- Publication Status
$ neb listupdates ----------------------------------------- Authentication Published Dark Mode Draft Payment Gateway Draft Notification System Published Bug Fix #12 Draft -----------------------------------------
This command is especially useful before starting a new update so you don't accidentally create duplicate work.
Best Practice
Always check existing updates before creating a new one. Someone on your team may already be working on the same feature.
neb history
Whenever a new developer joins a project, understanding its development history can be difficult. Nebula solves this using the neb history command. This command displays the complete timeline of every update that has ever been created for the project. Unlike neb listupdates, which only gives a summary, History provides a chronological record of project development.
The History includes
- Every published update
- Every unpublished update
- Creator of each update
- Date and time created
- Current status
- Publication information
$ neb history ------------------------------------------------------ Authentication Created By : Apoorv Status : Published Created On : 16 June 2026 ------------------------------------------------------ Dark Mode Created By : Sarah Status : Draft Created On : 19 June 2026 ------------------------------------------------------ Payment Gateway Created By : Rahul Status : Published Created On : 23 June 2026 ------------------------------------------------------
Project history allows new collaborators to quickly understand how the project has evolved over time without manually asking other developers.
Why is this useful?
Imagine joining a project that has been under development for months. Instead of guessing what happened previously, Nebula provides a complete history so every collaborator starts with full context.
Collaborating with Your Team
Nebula was built with collaboration in mind. Project owners can invite developers, while invited users can join the project, synchronize updates and immediately begin contributing. The following commands make collaboration effortless.
neb addcollab {email}
Software projects are rarely built alone. Nebula allows project owners to invite other developers into their projects using the neb addcollab command. After entering the collaborator's email address, Nebula sends an invitation containing the necessary information to join the project. Only the project owner can invite collaborators.
Syntax
neb addcollab {email}
Example
$ neb addcollab john@example.com ✔ Invitation sent successfully. Recipient: john@example.com
Once the invitation has been accepted, the invited user can join the project using the neb joinproject command.
Note
Only invited users can join a project. Simply knowing the project code is not enough.
neb joinproject
After receiving an invitation, collaborators can become part of the project using the neb joinproject command. Nebula will ask for two credentials provided by the project owner.
- Project Code
- Project Password
Once both are verified, Nebula automatically creates the project directory on your computer and prepares it for development.
$ neb joinproject Project Code : A73K-29PQ Project Password : ******** ✔ Project joined successfully.
What happens next?
Joining the project gives you access to every published and unpublished update. Use neb sync immediately afterwards to download the complete project.
neb install {update_name}
Sometimes you don't need the entire project. Instead, you may only want one specific update. The neb install command downloads only the update you specify, saving both time and storage. This command is especially useful when reviewing a feature or testing a particular update.
Syntax
neb install Authentication
Example
$ neb install Authentication Downloading... Authentication downloaded successfully.
When should I use this?
Use neb install when you only need one update. If you need the entire project, use neb sync instead.
neb sync
The neb sync command downloads the latest version of the project along with every available update. This is the fastest way for new collaborators to prepare their local workspace. Nebula automatically checks the server, compares your local project with the latest available version and downloads any missing updates.
What does Sync download?
- The latest project version.
- Every published update.
- Every unpublished update you have permission to access.
- The newest project metadata.
$ neb sync Checking server... Downloading project... Downloading updates... ✔ Project synchronized successfully.
Recommended
Run neb sync every time you begin working on a shared project. This ensures you always have the newest version of the project before making changes.
neb --help
The neb --help command displays every available Nebula command together with a short description. Whenever you forget a command or need a reminder, this should be your first stop.
$ neb --help Available Commands neb signup neb login neb startproject neb startupdate neb workon neb listupdates neb history neb addcollab neb joinproject neb install neb sync
You can access the help menu at any time without being logged in.
Complete Nebula Workflow
Now that you've learned every command individually, let's see how they fit together in a real-world development workflow. The following example demonstrates how a project owner creates a project, collaborates with teammates and keeps everyone synchronized.
Typical Workflow for a Project Owner
The following example demonstrates a complete development cycle using Nebula. If you're creating a brand-new project, this is the recommended order of commands.
# Install Nebula pip install nebula # Create your account neb signup # Login neb login # Create a project neb startproject # Create your first feature neb startupdate # Work on the feature neb workon Authentication # View every update neb listupdates # Invite teammates neb addcollab teammate@example.com # View project history neb history
Typical Workflow for a Collaborator
If another developer has invited you to a Nebula project, the following workflow is recommended.
# Login neb login # Join the project neb joinproject # Download the project neb sync # Continue working neb workon Authentication # Download a specific update neb install PaymentGateway # View project history neb history
Best Practices
Following these recommendations will help keep your projects organized and improve collaboration.
Create Small Updates
Instead of creating one huge update containing many features, split work into multiple smaller updates. This makes collaboration easier and project history cleaner.
Sync Frequently
Run neb sync before starting work every day. This ensures your local project always matches the latest version.
Name Updates Clearly
Good examples include:
- Authentication
- Landing Page
- Dark Mode
- Payment Gateway
- Bug Fix #24
Avoid names such as "Update1" or "Testing".
Review History
Use neb history whenever joining an existing project. It helps you understand previous work before making changes.
Frequently Asked Questions
Do I need Git to use Nebula?
No. Nebula is a standalone Version Control System and does not require Git.
Can multiple developers work on the same project?
Yes. Project owners can invite collaborators using neb addcollab, allowing multiple developers to work on the same project simultaneously.
What is the difference between an Update and a Project?
A Project contains the entire application. An Update represents a single feature, improvement or bug fix inside that project.
What's the difference between install and sync?
neb install downloads one specific update. neb sync downloads the entire project along with every available update.
Can I work on multiple updates?
Yes. Simply switch between updates using neb workon whenever needed.
How can I see all available commands?
Run:
neb --help
Why Developers Choose Nebula
Simple Commands
Nebula replaces complicated workflows with intuitive commands that are easy to remember.
Built for Collaboration
Invite teammates, synchronize updates and keep everyone working on the latest version of the project with minimal setup.
Organized Development
Every feature lives in its own update, making projects cleaner and easier to maintain.
Designed for Beginners
Nebula is easy enough for students learning version control while still being powerful enough for professional software development.
Ready to Build with Nebula?
Start managing projects, collaborating with teammates and tracking your development workflow using Nebula's simple yet powerful command-line experience.
Download Latest Version