ambral 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -2
- package/dist/ambral.js +26890 -0
- package/package.json +31 -4
package/README.md
CHANGED
|
@@ -1,3 +1,41 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ambral
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The `ambral` command: use Ambral from a terminal, or let a coding agent use it. It signs in through the browser,
|
|
4
|
+
then calls Ambral as you.
|
|
5
|
+
|
|
6
|
+
Requires Node 22 or later.
|
|
7
|
+
|
|
8
|
+
```sh
|
|
9
|
+
npx ambral login
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
`login` prints a link and a code. Open the link, check the code matches, and approve. In a terminal it also opens
|
|
13
|
+
the browser and waits for you. An agent, with no terminal, gets the link and exits; `ambral login --wait` then
|
|
14
|
+
returns once you approve.
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
| Command | What it does |
|
|
19
|
+
| --------------------------- | -------------------------------------------------------------------- |
|
|
20
|
+
| `ambral login [--wait]` | Sign in through the browser |
|
|
21
|
+
| `ambral whoami` | Show the account you're signed in as, the address, and the org |
|
|
22
|
+
| `ambral logout` | End this CLI's session on the server and forget it |
|
|
23
|
+
| `ambral orgs list` | List your orgs, with your role and each org's status |
|
|
24
|
+
| `ambral orgs use <slug>` | Link this project to an org: commands run in it act in that org |
|
|
25
|
+
| `ambral orgs create <name>` | Create an org you own, linking this project to it if it isn't linked |
|
|
26
|
+
| `ambral keys list` | List the org's API keys: names and starts, never their secrets |
|
|
27
|
+
|
|
28
|
+
Every command takes `--json`, which prints the result, or the failure, as JSON. `--org <slug>` acts in that org
|
|
29
|
+
in place of the one the project is linked to. Create and revoke API keys in the web app.
|
|
30
|
+
|
|
31
|
+
## Where it connects
|
|
32
|
+
|
|
33
|
+
`ambral` talks to `https://app.ambral.ai`. Set `AMBRAL_URL` to use another Ambral; each address keeps its own
|
|
34
|
+
sign-in and its own project links.
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
AMBRAL_URL=http://localhost:1340 npx ambral whoami
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Sessions are kept in `$XDG_CONFIG_HOME/ambral/sessions/` (`~/.config/ambral/sessions/` by default), readable only
|
|
41
|
+
by you. A project's org link is `.ambral/project.json`, which ignores itself in git.
|