Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.
/ marina-cli Public archive

Marina is a CLI tool to provide simple, shareable domains for your dev environment.

License

Notifications You must be signed in to change notification settings

shnhrrsn/marina-cli

Repository files navigation

marina-cli

Build Status Total Downloads Latest Version License

Marina is a CLI tool to provide simple, shareable domains by creating a reverse proxy with Caddy and serving *.localhost via Dnsmasq. No need to mess with hosts files, quickly and easily turn http://localhost:3000 into http://domain.localhost.

Marina also integrates with ngrok allowing you to create a publicly shareable link with a simple marina share command.

Marina was inspired by Laravel Valet, however running Marina and Valet side by side is not supported.

Installation

npm install -g marina-cli
sudo marina install

Usage

Managing Settings

  • domain: Change the default domain TLD from .localhost
  • ssl on: Turn support for ssl on
  • ssl off: Turn support for ssl off

Managing Projects

  • dock: Register a project with Marina
  • list: Lists all registered domains.
  • open: Opens a Marina project in the browser.
  • share: Generate a shareable URL for a project.
  • undock: Unregister a project with Marina

Managing the Toolchain

  • install: Install the Marina toolchain
  • uninstall: Uninstall the Marina toolchain
  • update: Update the Marina toolchain

Manage Services

  • start: Start Caddy & Dnsmasq
  • stop: Stop Caddy & Dnsmasq
  • restart: Restart Caddy & Dnsmasq

--save

When running marina dock pass the --save flag (ex: marina dock --save) to persist your settings. This will enable Marina to save the domain/source host settings to a .marina.json file in the current directory.

The dock, undock, open and share commands will read from .marina.json if it exists, allowing you to quickly run those commands without needing to specify a domain.

About

Marina is a CLI tool to provide simple, shareable domains for your dev environment.

Resources

License

Stars

Watchers

Forks

Packages

No packages published