feat(cli): rename CLI binary to hypergraph (+ hg alias) and update docs

apps/typesync/README.md

@@ -1,38 +1,40 @@
-# @graphprotocol/typesync
+# @graphprotocol/hypergraph-cli
 
-CLI toolchain to view existing types, select, pick, extend to create schemas and generate a [@graphprotocol/hypergraph](https://github.com/graphprotocol/hypergraph/tree/main/packages/hypergraph) schema.
+# Hypergraph command-line toolchain for scaffolding and working with Hypergraph applications.
 
 ## Installing
 
 ```bash
 # npm
-npm i -g @graphprotocol/typesync-cli
+npm i -g @graphprotocol/hypergraph-cli
 
 # yarn
-yarn global add @graphprotocol/typesync-cli
+yarn global add @graphprotocol/hypergraph-cli
 
 # pnpm
-pnpm install -g @graphprotocol/typesync-cli
+pnpm install -g @graphprotocol/hypergraph-cli
 ```
 
 ## Running
 
 ```bash
-typsync --help
+hypergraph --help
+hg --help   # short alias
 
-# opening typesync studio
-typesync studio
+# opening Hypergraph studio
+hypergraph studio
+hg studio
 
-# opening typesync studio in firefox automatically
-typesync studio --open --browser firefox
+# opening Hypergraph studio in firefox automatically
+hypergraph studio --open --browser firefox
 ```
 
 ## Commands
 
-- `studio` -> runs the `Typesync` api and client UI application for viewing created application schemas, browsing the Knowledge Graph, and creating new application schemas.
-  - running: `typesync studio`
+- `studio` -> runs the Hypergraph API and client UI application for viewing created application schemas, browsing the Knowledge Graph, and creating new application schemas.
+  - running: `hypergraph studio`
   - args:
     - `port` [OPTIONAL, default = 3000] port to run the application on
-      - example: `typesync studio --port 3001`
+      - example: `hypergraph studio --port 3001`
     - `browser` [OPTION, default 'browser'] browser to open the app in, if the `--open` flag is passed
-      - example: `typesync studio --open --browser firefox`
+      - example: `hypergraph studio --open --browser firefox`

apps/typesync/package.json

@@ -15,7 +15,8 @@
     "linkDirectory": false
   },
   "bin": {
-    "typesync": "./dist/bin.cjs"
+    "hypergraph": "./dist/bin.cjs",
+    "hg": "./dist/bin.cjs"
   },
   "files": ["README.md", "dist"],
   "scripts": {
@@ -35,7 +36,7 @@
     "copy-db-migrations": "cp -rp ./src/migrations ./dist/migrations",
     "copy-client-dist": "mkdir -p ./dist/client && cp -rp ./client/dist ./dist/client/dist",
     "copy-all": "pnpm run copy-package-json && pnpm run copy-db-migrations && pnpm run copy-client-dist",
-    "typesync": "pnpx tsx ./src/bin.ts studio"
+    "hypergraph": "pnpx tsx ./src/bin.ts studio"
   },
   "devDependencies": {
     "@effect/cli": "latest",

apps/typesync/scripts/copy-package-json.ts

@@ -13,7 +13,10 @@ const program = Effect.gen(function* () {
     type: json.type,
     description: json.description,
     main: 'bin.cjs',
-    bin: 'bin.cjs',
+    bin: {
+      hypergraph: 'bin.cjs',
+      hg: 'bin.cjs',
+    },
     engines: json.engines,
     dependencies: json.dependencies,
     peerDependencies: json.peerDependencies,

apps/typesync/src/Cli.ts

@@ -2,14 +2,14 @@ import * as Command from '@effect/cli/Command';
 
 import { studio } from './subcommands/studio.js';
 
-const typesync = Command.make('typesync').pipe(
+const hypergraph = Command.make('hypergraph').pipe(
   Command.withDescription(
-    'Typesync command line interface for building and interacting with @graphprotocol/hypergraph schemas',
+    'Hypergraph command line interface for building and interacting with @graphprotocol/hypergraph schemas',
   ),
   Command.withSubcommands([studio]),
 );
 
-export const run = Command.run(typesync, {
-  name: 'typesync',
+export const run = Command.run(hypergraph, {
+  name: 'hypergraph',
   version: '0.0.0-alpha',
 });