rgm-installer
v0.2.0
Published
Bootstrap installer for the Remote Git Manager machine agent.
Readme
rgm-installer
Bootstrap installer for the Remote Git Manager machine agent.
This package is meant to be run with npx on the Linux or VPS machine you want to connect to a Remote Git Manager relay.
What it does
- downloads a prebuilt agent bundle from the release manifest
- installs it into
~/.remote-git-manager - starts the local machine agent
- connects the machine to your relay URL
- prints a pairing code so you can claim the machine from the browser
When a user-level systemd environment is available, the installer tries to register rgm-agent.service. If not, it falls back to running the agent as a detached background process.
Quick start
npx -y rgm-installer --relay https://your-relay.example.comAfter install, open the hosted dashboard for that relay and claim the pairing code printed by the installer.
Requirements
- Linux or another Unix-like environment with
taravailable - Node.js new enough for the selected agent release
- a reachable Remote Git Manager relay URL
- a valid agent release manifest and release artifact host
Options
--relay <url> Hosted relay URL to connect this machine to
--install-dir <path> Install root (default: ~/.remote-git-manager)
--version <version> Install a specific agent version
--manifest-url <url> Override the release manifest URL
--no-pair Skip automatic pairing code generation
--help Show helpExamples
Install against a self-hosted Node relay:
npx -y rgm-installer --relay https://relay.example.comInstall a specific agent version:
npx -y rgm-installer --relay https://relay.example.com --version 0.1.1Use a custom manifest URL:
npx -y rgm-installer \
--relay https://relay.example.com \
--manifest-url https://downloads.example.com/agent-manifest.jsonInstall without generating a pairing code immediately:
npx -y rgm-installer --relay https://relay.example.com --no-pairDefaults
- Install directory:
~/.remote-git-manager - Default manifest URL:
https://github.com/notkainoa/Remote-Git-Manager/releases/latest/download/agent-manifest.json
What gets installed
The installer creates a release-managed layout under the install root:
releases/<version>for downloaded runtime bundlescurrentas the active runtime symlinkdatafor machine statelogsfor local agent logsrunfor pid and runtime files
After install
If you skipped pairing, you can generate a new code later with:
~/.remote-git-manager/current/bin/rgm pairTo point the machine at a different relay later:
~/.remote-git-manager/current/bin/rgm connect https://your-relay.example.comRelay-hosted alternative
If your relay exposes the shell wrapper, this does the same bootstrap flow:
curl -fsSL https://your-relay.example.com/install.sh | shSource
Repository: https://github.com/notkainoa/Remote-Git-Manager
