Skip to content

the-bipu/novaflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 NovaFlow

Release License: MIT Nushell

A tiny, fast command-line launcher for switching between local dev projects.

Type dev in any terminal and instantly:

  • Open the project folder in VS Code
  • Start the dev server (e.g. npm run dev) in its own window
  • Open the local URL in your browser
  • Open the GitHub repo page

No more cd-ing around, no more remembering ports, no more retyping the same three commands every time you sit down to work.


✨ Features

  • One command (dev) launches your whole workspace
  • Direct launch: dev <novaflow> skips the menu entirely
  • Project registry in a single projects.json file — add a project by editing one line
  • Works from any terminal, any folder once installed
  • Built on Nushell — fast, cross-platform, scriptable

📦 Requirements

Tool Purpose Link
Nushell Runs the launcher script nushell.sh
VS Code Opens your projects code.visualstudio.com
Windows 10/11 PATH setup script targets Windows (.cmd + PowerShell)

Using macOS/Linux? The core launcher.nu script works as-is — just skip dev.cmd / setup.ps1 and add an alias to your shell profile instead (see Manual setup).


🛠 Installation

1. Clone or download this repo

git clone https://github.com/<the-bipu>/novaflow.git
cd novaflow

2. Install Nushell

Download from nushell.sh, or via winget:

winget install nushell

3. Run the one-time setup script (Windows)

powershell -ExecutionPolicy Bypass -File setup.ps1

This adds the project folder to your User PATH, so the dev command is available everywhere.

Close and reopen your terminal after this step.

4. Configure your projects

Open projects.json and list your own projects:

{
  "projects": [
    {
      "name": "my-app",
      "path": "E:/Projects/my-app",
      "frontend": "npm run dev",
      "url": "http://localhost:3000",
      "github": "https://github.com/you/my-app"
    }
  ]
}
Field Description
name Short identifier you'll type to launch the project
path Absolute path to the project folder
frontend Command to start the dev server (leave "" to skip)
url Local URL to open in browser (leave "" to skip)
github GitHub repo URL to open (leave "" to skip)

5. Launch it

dev

or jump straight into a project:

dev my-app

🧭 Usage

dev                # shows a menu of all projects, prompts for a name
dev sliet-alumni    # launches that project directly, no prompt

🖥 Manual / cross-platform setup

If you're not on Windows, or don't want to run setup.ps1:

  1. Add this folder to your PATH manually.
  2. Create a dev alias/script that calls nu launcher.nu from this folder, e.g. in ~/.bashrc or ~/.zshrc:
    alias dev="nu /path/to/dev-launcher/launcher.nu"
  3. Reload your shell (source ~/.bashrc) and run dev.

📂 Project Structure

dev-launcher/
├── launcher.nu     # Main script
├── config.nu       # Nushell startup banner/hints
├── dev.cmd         # Windows PATH entry point
├── setup.ps1       # One-time PATH installer (Windows)
├── projects.json   # Your project registry (edit this!)
└── README.md

🤝 Contributing

Issues and PRs welcome. Ideas on the roadmap:

  • Backend command support (run frontend + backend together)
  • Fuzzy project-name matching
  • Auto git pull before opening
  • Cross-platform installer script

📄 License

MIT — free to use, modify, and share.

About

A one-command CLI launcher for local dev projects — opens VS Code, starts your dev server, and launches your browser + GitHub tab, all in one keystroke. Built with Nushell.

Topics

Resources

License

Stars

5 stars

Watchers

0 watching

Forks

Contributors