https://github.com/rintoj/hypergraph-cli
Command line interface package for hypergraph project
https://github.com/rintoj/hypergraph-cli
Last synced: 4 months ago
JSON representation
Command line interface package for hypergraph project
- Host: GitHub
- URL: https://github.com/rintoj/hypergraph-cli
- Owner: rintoj
- License: mit
- Created: 2023-07-05T06:19:37.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-11-27T07:13:24.000Z (7 months ago)
- Last Synced: 2026-01-02T22:40:21.625Z (6 months ago)
- Language: TypeScript
- Size: 944 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hypergraph CLI
`hypergraph` is a command-line interface (CLI) tool designed to facilitate various tasks related to project management and deployment using the Hypergraph platform. Below is a comprehensive guide outlining available commands and their options.
## Install
Using npm:
```sh
npm install @hgraph/cli -g
```
## Usage
```sh
hypergraph [--help] [--doc]
```
### Commands
- `auth`: Commands for managing authentication and access.
- `build`: Build a project.
- `checkout`: Checkout a project.
- `collaborator`: Administer project collaborators and permissions.
- `config`: View or update configuration.
- `create`: Create a package and other resources.
- `deploy`: Deploy a project.
- `gcloud`: Configure and install tools for Google Cloud.
- `generate`: Generate project models and resolvers using AI.
- `project`: Manage your projects.
- `save`: Save a source file to a given project.
## hypergraph auth
Commands for managing authentication and access.
### `hypergraph auth login`
Access your Hypergraph account by logging in.
```sh
hypergraph auth login [--provider=]
```
Options:
- `--provider=`: Authenticate using Google or Github credentials.
### `hypergraph auth logout`
Sign out of your account.
```sh
hypergraph auth logout
```
### `hypergraph auth user`
Display information of the currently logged-in user.
```sh
hypergraph auth user
```
## hypergraph build
Build a project.
```sh
hypergraph build --environment= [--api=] [--db-port=] [--clean]
```
Options:
- `--environment=` (Required): Specify the project environment.
- `--api=`: List all API services in the format "name:port" for local exposure.
- `--db-port=`: Expose the database through a specified port, if defined.
- `--clean`: Perform a clean build by removing previous environments, cache, and config.
## hypergraph checkout
Checkout a project.
```sh
hypergraph checkout [--project-id=] [--skip-cache]
```
Options:
- `--project-id=`: Specify the ID of the project to checkout.
- `--skip-cache`: Disable cache (enabled by default).
## hypergraph collaborator
Administer project collaborators and permissions.
### `hypergraph collaborator add`
Add a collaborator to the project.
```sh
hypergraph collaborator add [--project-id=]
```
Options:
- `--project-id=`: Specify the ID of the project.
### `hypergraph collaborator list`
Display contributors within a project.
```sh
hypergraph collaborator list [--project-id=]
```
Options:
- `--project-id=`: Project ID.
### `hypergraph collaborator remove`
Remove a collaborator from the project.
```sh
hypergraph collaborator remove [--project-id=]
```
Options:
- `--project-id=`: Project ID.
## hypergraph config
View or update configuration.
### `hypergraph config remote`
View or update remote server URL.
```sh
hypergraph config remote [url]
```
Arguments:
- `url`: Server URL.
## hypergraph create
Create a package and other resources.
### `hypergraph create package`
Create a package.
```sh
hypergraph create package [name]
```
Arguments:
- `name`: Name of the package.
## hypergraph deploy
Deploy a project.
```sh
hypergraph deploy --environment= [--create] [--clean]
```
Options:
- `--environment=` (Required): Specify the deployment environment.
- `--create`: Create missing resources like cluster, container registry, and certificates as needed.
- `--clean`: Perform a clean build by removing previous environments, cache, and config.
## hypergraph gcloud
Configure and install tools for Google Cloud.
### `hypergraph gcloud setup`
Configure the Google Cloud environment.
```sh
hypergraph gcloud setup --environment=
```
Options:
- `--environment=` (Required): Select the target environment.
### `hypergraph gcloud install`
Install all required libraries for Google Cloud.
```sh
hypergraph gcloud install --environment=
```
Options:
- `--environment=` (Required): Specify the target environment.
## hypergraph generate
Generate project models and resolvers using AI.
```sh
hypergraph generate [--project-id=]
```
Options:
- `--project-id=`: Specify the ID of the project.
## hypergraph project
Manage your projects.
### `hypergraph project create`
Create a project.
```sh
hypergraph project create [project-name]
```
Arguments:
- `project-name`: Name of the project.
### `hypergraph project list`
List all projects.
```sh
hypergraph project list
```
### `hypergraph project remove`
Remove a project.
```sh
hypergraph project remove [--project-id=]
```
Options:
- `--project-id=`: ID of the project to be removed.
## hypergraph save
Save a source file to a given project.
```sh
hypergraph save [--project-id=]
```
Arguments:
- `source-file`: Source file(s) to upload. You may use glob patterns.
Options:
- `--project-id=`: Project ID in Hypergraph.