Documentation

Everything you need to know about using mrq.

Getting Started

Installation

Install the mrq CLI globally using npm:

npm install -g mrq-cli@latest

Authentication

Log in to connect your CLI to your account:

mrq login

This opens your browser to authenticate. After authentication, you'll receive an API key that's stored locally.

Start Watching

Navigate to your project directory and start the watcher:

cd ~/your-project
mrq watch

mrq will create a workspace for your project and begin capturing snapshots automatically.

Commands

mrq watch

Start watching the current directory for changes. Snapshots are captured automatically when meaningful changes occur.

Options: --daemon to run in background

mrq history

Show recent snapshots for the current workspace. Displays snapshot ID, timestamp, description, and change summary.

mrq restore <id>

Restore your project to a specific snapshot. Your current state is automatically backed up before restore.

mrq daemon status

Check if the mrq daemon is running in the background.

mrq daemon stop

Stop the background daemon for the current workspace.

mrq whoami

Show information about the currently authenticated user and workspaces.

mrq logout

Remove stored authentication credentials.

How It Works

File Monitoring

mrq uses file system watchers to detect changes in your project. When files are modified, created, or deleted, mrq waits for a brief pause in activity before capturing a snapshot. This prevents capturing incomplete changes while an AI is still writing.

Snapshots

Each snapshot captures the complete state of changed files. Snapshots include an AI-generated description summarizing what changed, making it easy to find the point you want to restore to.

Encryption

File contents are encrypted on your machine before being uploaded. Your code is encrypted with a key derived from your account. We cannot read your source code.

Gitignore Support

mrq respects your .gitignore file. Ignored files are not captured in snapshots. Node modules, build artifacts, and other ignored files are excluded automatically.

FAQ

Does mrq replace git?

No. mrq complements git. Use mrq for continuous protection during development, and git for collaboration and deployment. They work together.

What happens when I restore?

Your current state is automatically backed up before restore. You can always recover it by running mrq history and restoring to the backup snapshot.

How much storage do I get?

Free tier includes 500MB storage, 1 workspace, and 100 snapshots/month. Paid plans include more storage and workspaces. See billing for details.

Is my code private?

Yes. Code is encrypted on your machine before upload. We use AES-256 encryption with keys derived from your account. We cannot access your source code.

More Resources

Support

Need help? We're here for you.