Vizora

Vizora is a simple deployment CLI for Node.js projects.

It deploys your Node.js app to a remote server using SSH, Git, npm, and PM2.

What Vizora Supports

Vizora currently supports Node.js app deployment only.

Your Node.js project should have:

package.json
.env.example
vizora.config.json

Install Locally

From the Vizora repo:

npm install
npm link -w cli

Then check:

vizora --help

Create vizora.config.json

Inside your Node.js project, create:

{
  "name": "my-node-app",
  "repo": "https://github.com/username/my-node-app.git",
  "branch": "main",
  "server": "user@example-server",
  "basePath": "/home/user/apps",
  "preStart": "",
  "start": "npm start"
}

Example with nodemon:

{
  "name": "oauth",
  "repo": "https://github.com/vizzscript/OAuth_Server.git",
  "branch": "master",
  "server": "vizzscript@home-server",
  "basePath": "/home/vizzscript/api",
  "preStart": "npm install nodemon --no-save",
  "start": "npm run dev"
}

Environment Variables

If your project has .env.example, Vizora reads it during deploy and asks for values.

Example .env.example:

PORT=3000
MONGO_URI=mongodb+srv://<username>:<password>@<cluster>/<database>
CLIENT_ID=<google-client-id>
CLIENT_SECRET=<google-client-secret>
REDIRECT_URI=http://localhost:3000/auth/oauth2callback

Values that are blank or use placeholders like <google-client-id> are treated as required.

Deploy

Run this from inside your Node.js project folder:

vizora deploy

Vizora will:

1. Load vizora.config.json
2. Read .env.example
3. Ask for environment values
4. SSH into the server
5. Create a new timestamped release
6. Run npm install
7. Write .env into the release
8. Run preStart if configured
9. Point current to the new release
10. Start the app with PM2 from current
11. Show PM2 status

Rollback

Every deploy creates a release folder:

<basePath>/<name>/releases/<yyyy-mm-dd-HHMM>

The active app is always:

<basePath>/<name>/current

PM2 starts the app from current, so rollback can move current back to the previous release:

vizora rollback

Rollback will:

1. Find the release before the current one
2. Point current back to that release
3. Restart the PM2 process
4. Show PM2 status

Commands

Show logs:

vizora logs

Show more log lines:

vizora logs --lines 200

Show PM2 status:

vizora status

Restart the app:

vizora restart

Roll back to the previous release:

vizora rollback

Stop the app:

vizora stop

Remove the app from PM2:

vizora remove

Remove the app from PM2 and delete deployed files:

vizora remove --files

Remote Folder

Vizora deploys to:

<basePath>/<name>/current

For example:

{
  "name": "oauth",
  "basePath": "/home/vizzscript/api"
}

Deploys to:

/home/vizzscript/api/oauth/current

Releases are stored in:

/home/vizzscript/api/oauth/releases

Notes

• The remote server must have Git, Node.js, npm, and PM2 installed.
• The local machine must be able to SSH into the configured server.
• Vizora preserves the remote .env during repository cleanup.
• vizora remove --files deletes only the configured app folder.