🗺️ GitMaps CLI

Command Line Interface for GitMaps — Open repositories in GitMaps from terminal!

🚀 Quick Start

# Install globally
npm install -g gitmaps-cli

# Open current repository in GitMaps
gitmaps open

# Open specific repository
gitmaps open /path/to/repo

# Use local GitMaps server
gitmaps open -l

# Copy shareable URL
gitmaps share

📖 Commands

gitmaps open [path]

Open a repository in GitMaps.

# Open current directory
gitmaps open

# Open specific path
gitmaps open /path/to/repo

# Use local server
gitmaps open -l

# Use custom server
gitmaps open -u https://gitmaps.xyz

# Specify GitHub owner/repo manually
gitmaps open -o 7flash -r gitmaps

Options:

• -u, --url <url> — GitMaps server URL (default: https://gitmaps.xyz)
• -l, --local — Use local server (localhost:3335)
• -o, --owner <owner> — GitHub owner (auto-detected from git remote)
• -r, --repo <repo> — GitHub repo name (auto-detected)

gitmaps snapshot [path]

Generate a canvas snapshot (placeholder for GitHub Action integration).

gitmaps snapshot
gitmaps snapshot -o snapshot.png -w 1920 -h 1080

Options:

• -o, --output <file> — Output file path (default: gitmaps-snapshot.png)
• -w, --width <width> — Snapshot width (default: 1920)
• -h, --height <height> — Snapshot height (default: 1080)
• -u, --url <url> — GitMaps server URL

gitmaps share [path]

Copy shareable GitMaps URL to clipboard.

gitmaps share
gitmaps share /path/to/repo
gitmaps share -l  # Local server URL

Options:

• -u, --url <url> — GitMaps server URL
• -l, --local — Use local server

gitmaps status

Check if GitMaps server is online.

gitmaps status
gitmaps status -u http://localhost:3335

Options:

• -u, --url <url> — GitMaps server URL to check

gitmaps config

Show GitMaps CLI configuration and available commands.

gitmaps config

🎯 Use Cases

1. Quick Open from Terminal

cd my-project
gitmaps open
# Opens in browser instantly!

2. Share with Team

gitmaps share
# URL copied to clipboard
# Paste in Slack/Discord/Email

3. Local Development

gitmaps open -l
# Opens local GitMaps instance

4. CI/CD Integration

# In GitHub Actions
- name: Open in GitMaps
  run: gitmaps open -u https://gitmaps.xyz

🔧 Installation

npm

npm install -g gitmaps-cli

yarn

yarn global add gitmaps-cli

bun

bun add -g gitmaps-cli

From Source

git clone https://github.com/7flash/gitmaps.git
cd gitmaps/gitmaps-cli
npm install
npm link

📊 Examples

Open Current Project

$ cd my-awesome-project
$ gitmaps open
🗺️ Opening in GitMaps: https://gitmaps.xyz/owner/my-awesome-project
✅ GitMaps opened in your browser!

Share Repository URL

$ gitmaps share
✅ GitMaps URL copied to clipboard:
   https://gitmaps.xyz/owner/my-awesome-project

Check Server Status

$ gitmaps status
🔍 Checking GitMaps status: https://gitmaps.xyz
✅ GitMaps is online!
   URL: https://gitmaps.xyz
   Status: 200

Show Configuration

$ gitmaps config
🗺️ GitMaps CLI Configuration

Default Settings:
  Base URL: https://gitmaps.xyz
  Local URL: http://localhost:3335

Commands:
  gitmaps open [path]     - Open repository in GitMaps
  gitmaps snapshot [path] - Generate canvas snapshot
  gitmaps share [path]    - Copy shareable URL
  gitmaps status          - Check server status
  gitmaps config          - Show this config

🙏 Acknowledgments

Built for GitMaps — Spatial Code Explorer.

📄 License

ISC © 7flash

Explore code spatially from your terminal! 🗺️