|
1 | | -# hyp |
| 1 | +<!-- markdownlint-disable first-line-heading --> |
| 2 | +<div align="center"> |
| 3 | + |
| 4 | + [](https://github.com/hypermodeinc/hyp-cli?tab=Apache-2.0-1-ov-file#readme) |
| 5 | + [](https://discord.hypermode.com) |
| 6 | + [](https://github.com/hypermodeinc/hyp-cli/stargazers) |
| 7 | + [](https://github.com/hypermodeinc/hyp-cli/commits/main/) |
2 | 8 |
|
3 | | -A new CLI for the Hypermode service |
| 9 | +</div> |
4 | 10 |
|
5 | | -[](https://oclif.io) |
6 | | -[](https://npmjs.org/package/hyp) |
7 | | -[](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> |
8 | 16 |
|
9 | | -<!-- toc --> |
| 17 | +Hyp is the command line interface (CLI) for [Hypermode](https://hypermode.com). |
10 | 18 |
|
11 | | -- [hyp](#hyp) |
12 | | -- [Usage](#usage) |
13 | | -- [Commands](#commands) |
14 | | -<!-- tocstop --> |
| 19 | +## Quickstart |
15 | 20 |
|
16 | | -## Usage |
| 21 | +Install the Hyp CLI |
17 | 22 |
|
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 |
30 | 25 | ``` |
31 | 26 |
|
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 |
43 | 28 |
|
44 | | -Login to Hypermode Console |
45 | | - |
46 | | -```sh |
47 | | -hyp login |
| 29 | +```bash |
| 30 | +modus new |
48 | 31 | ``` |
49 | 32 |
|
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 |
55 | 34 |
|
56 | | -```sh |
57 | | -hyp logout |
| 35 | +```bash |
| 36 | +modus dev |
58 | 37 | ``` |
59 | 38 |
|
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 |
65 | 40 |
|
66 | | -```sh |
67 | | -hyp org switch |
| 41 | +```bash |
| 42 | +hyp link |
68 | 43 | ``` |
69 | 44 |
|
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 |
71 | 46 |
|
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