Skip to content
This repository was archived by the owner on Aug 21, 2025. It is now read-only.

Commit f6aacc0

Browse files
authored
Update README.md
1 parent 1b37195 commit f6aacc0

File tree

1 file changed

+30
-54
lines changed

1 file changed

+30
-54
lines changed

README.md

Lines changed: 30 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,48 @@
1-
# hyp
1+
<!-- markdownlint-disable first-line-heading -->
2+
<div align="center">
3+
4+
[![GitHub License](https://img.shields.io/github/license/hypermodeinc/hyp-cli)](https://github.com/hypermodeinc/hyp-cli?tab=Apache-2.0-1-ov-file#readme)
5+
[![chat](https://img.shields.io/discord/1267579648657850441)](https://discord.hypermode.com)
6+
[![GitHub Repo stars](https://img.shields.io/github/stars/hypermodeinc/hyp-cli)](https://github.com/hypermodeinc/hyp-cli/stargazers)
7+
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/hypermodeinc/hyp-cli)](https://github.com/hypermodeinc/hyp-cli/commits/main/)
28

3-
A new CLI for the Hypermode service
9+
</div>
410

5-
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
6-
[![Version](https://img.shields.io/npm/v/hyp.svg)](https://npmjs.org/package/hyp)
7-
[![Downloads/week](https://img.shields.io/npm/dw/hyp.svg)](https://npmjs.org/package/hyp)
11+
<p align="center">
12+
<a href="https://docs.hypermode.com/quickstart">Get Started</a> ·
13+
<a href="https://docs.hypermode.com/hyp-cli">Docs</a> ·
14+
<a href="https://discord.hypermode.com">Discord</a>
15+
<p>
816

9-
<!-- toc -->
17+
Hyp is the command line interface (CLI) for [Hypermode](https://hypermode.com).
1018

11-
- [hyp](#hyp)
12-
- [Usage](#usage)
13-
- [Commands](#commands)
14-
<!-- tocstop -->
19+
## Quickstart
1520

16-
## Usage
21+
Install the Hyp CLI
1722

18-
<!-- usage -->
19-
20-
```sh-session
21-
$ npm install -g @hypermode/hyp-cli
22-
$ hyp COMMAND
23-
running command...
24-
$ hyp (--version)
25-
@hypermode/hyp-cli/0.0.1-alpha.1 darwin-arm64 node-v22.9.0
26-
$ hyp --help [COMMAND]
27-
USAGE
28-
$ hyp COMMAND
29-
...
23+
```bash
24+
npm install -g @hypermode/hyp-cli
3025
```
3126

32-
<!-- usagestop -->
33-
34-
## Commands
35-
36-
<!-- commands -->
37-
38-
- [`hyp login`](#hyp-login)
39-
- [`hyp logout`](#hyp-logout)
40-
- [`hyp org switch`](#hyp-org-switch)
41-
42-
### `hyp login`
27+
Initialize your Modus app
4328

44-
Login to Hypermode Console
45-
46-
```sh
47-
hyp login
29+
```bash
30+
modus new
4831
```
4932

50-
_See code: [src/commands/login/index.ts](https://github.com/hypermodeinc/hyp-cli/blob/v0.0.1-alpha.1/src/commands/login/index.ts)_
51-
52-
### `hyp logout`
53-
54-
Logout of Hypermode Console in the CLI
33+
Run your app locally with fast refresh
5534

56-
```sh
57-
hyp logout
35+
```bash
36+
modus dev
5837
```
5938

60-
_See code: [src/commands/logout/index.ts](https://github.com/hypermodeinc/hyp-cli/blob/v0.0.1-alpha.1/src/commands/logout/index.ts)_
61-
62-
### `hyp org switch`
63-
64-
Switch the current Hypermode organization
39+
Link your Modus app repo to Hypermode
6540

66-
```sh
67-
hyp org switch
41+
```bash
42+
hyp link
6843
```
6944

70-
_See code: [src/commands/org/switch.ts](https://github.com/hypermodeinc/hyp-cli/blob/v0.0.1-alpha.1/src/commands/org/switch.ts)_
45+
## License
7146

72-
<!-- commandsstop -->
47+
Hyp CLI is Copyright 2024 Hypermode Inc., and licensed under the terms of the Apache License, Version 2.0.
48+
See the [LICENSE](./LICENSE) file for a complete copy of the license.

0 commit comments

Comments
 (0)