Skip to content

Commit 994120a

Browse files
committed
add hyp-cli commands
1 parent 678b057 commit 994120a

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

hyp-cli.mdx

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
11
---
22
title: Hyp CLI
3-
description: ""
3+
description: "Comprehensive refernce for the Hyp CLI commands and usage."
44
---
55

6-
<Warning>- setup - `login`, `deploy`, `import`</Warning>
6+
<Warning>- setup - `login`, `logout`, `org`, `init`</Warning>
7+
8+
## Hyp CLI reference
9+
10+
### Overview
11+
12+
- The Hyp CLI is a command-line tool for managing your Hypermode account and projects.
13+
- To install, download from TODO: add link.
14+
- To get started, run `hyp login` and authenticate with your Hypermode account. Authenticating gives access to running
15+
Hypermode hosted models from your local device.
16+
17+
### Commands
18+
19+
#### `login`
20+
21+
- **Description**: Log in to your Hypermode account. `login` redirects to the Hypermode website to authenticate.
22+
It then stores an authentication token locally, and prompts you to select a default org.
23+
- **Usage**: `hyp login`
24+
- **Options**: None
25+
- **Examples**:
26+
- Log in to your Hypermode account: `hyp login`
27+
28+
#### `logout`
29+
30+
- **Description**: Log out of your Hypermode account. This command clears your local authentication token.
31+
- **Usage**: `hyp logout`
32+
- **Options**: None
33+
- **Examples**:
34+
- Log out of your Hypermode account: `hyp logout`
35+
36+
#### `org`
37+
38+
- **Description**: The `org` command controls all org related operations.
39+
- **Usage**: `hyp org [command]`
40+
- **Options**:
41+
- `switch`: Switch to a different org.

styles/config/vocabularies/general/accept.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Hyp
2424
[Hh]ypercategories
2525
[Hh]ypermode
2626
inferencing
27-
log
27+
[Ll]og
2828
[Mm]odus
2929
namespace
3030
nnClassify

0 commit comments

Comments
 (0)