Skip to content

Conversation

marcusrein
Copy link
Member

📦 PR Description

Why

  • Requested by @cmwhited (see task list below).
  • The old command typesync no longer reflects the Hypergraph brand and felt redundant when launching the studio (typesync studio).
  • This PR re-brands the CLI to hypergraph, introduces a short alias hg, and updates docs/scripts accordingly.

What’s inside

  1. CLI rename

    • Root command in apps/typesync/src/Cli.tshypergraph
    • Command.run meta updated (name: 'hypergraph')
  2. Executable mapping

    // apps/typesync/package.json
    "bin": {
      "hypergraph": "./dist/bin.cjs",
      "hg":         "./dist/bin.cjs"
    }
    • Added matching hypergraph script for local dev.
  3. Build artifact update

    • scripts/copy-package-json.ts now copies the same bin map into dist/package.json.
  4. Docs

    • README retitled @graphprotocol/hypergraph-cli with new install / usage examples (includes hg).
  5. Smoke test

    pnpm run build && pnpm link --global
    hypergraph --help
    hg studio --port 4000 --open=false
  6. Alias support

    • Users may type either hypergraph … or hg ….

Breaking change?

Yes – typesync is no longer installed.
A migration note will be included in release notes; we can ship a one-version symlink if needed.


Full Task List from Chris

  • 1 & 2. Rename CLI binary + adjust NPM bin (this PR)
  • 3. Fix “open browser” logic (hard-coded Firefox / Arc error)
  • 4. Verify local dev workflow (dev:cli, dev:client)
  • 5. Add useQueryEntity generator (optional)
  • 6. Bundle other async “wins”
  • 7. Begin auth / wallet integration for on-chain publish

How to test locally

cd apps/typesync
pnpm i
pnpm run build
pnpm link --global        # ensure $PNPM_HOME is on PATH
hypergraph --help
hg studio --open=false --port 4000

This PR fully delivers items #1 and #2 of the task list.

@marcusrein marcusrein self-assigned this Jun 23, 2025
Copy link

vercel bot commented Jun 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hypergraph-connect ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 23, 2025 3:47pm
hypergraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 23, 2025 3:47pm

Copy link
Collaborator

@nikgraf nikgraf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! thanks

@marcusrein
Copy link
Member Author

Renamed “studio” → “typesync” in our CLI

• Renamed the studio sub-command to typesync
• Installation package renamed to @graphprotocol/typesync-cli
• Binaries now invoked as:

hypergraph typesync
hg typesync

• All examples in apps/typesync/README.md updated to reflect the new command name and flags (--port, --open, --browser)
• No other functionality or flags were changed—only the command name and docs

This brings the CLI name in line with its core “typesync” functionality and removes any leftover “studio” terminology.

@marcusrein marcusrein merged commit 886d01e into main Jun 24, 2025
6 checks passed
@marcusrein marcusrein deleted the cli-rename branch June 24, 2025 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants