@oya-ai/cli 0.1.0 → 1.0.57

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.
Files changed (2) hide show
  1. package/README.md +43 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # @oya-ai/cli
2
+
3
+ The `oya` command: start, drive and watch browsers on the Oya control plane from your terminal.
4
+
5
+ ```bash
6
+ npm i -g @oya-ai/cli
7
+ oya login # paste an API key from browser.getoya.ai
8
+ oya init # pick your model, browser provider and sign-ins
9
+ ```
10
+
11
+ ## A session
12
+
13
+ ```bash
14
+ oya start --persona auto # prints the browser id
15
+ oya goto https://example.com # defaults to the newest browser
16
+ oya ask "Find the pricing page" # drive it in plain language
17
+ oya open # watch it live
18
+ oya rm --all
19
+ ```
20
+
21
+ ## Commands
22
+
23
+ | Command | |
24
+ |---|---|
25
+ | `oya start [--persona auto] [--provider <p>]` | Start a browser and print its id |
26
+ | `oya goto <url>` · `oya ask "<prompt>"` | Navigate · drive it in plain language (`--id` picks a browser) |
27
+ | `oya ls` · `oya rm <id> \| --all` | List · stop browsers |
28
+ | `oya status` · `oya open` | Health and recent activity · open the live view |
29
+ | `oya personas [new \| edit \| clone \| rm]` | Identities: fingerprint + cookies + proxy |
30
+ | `oya config [key=value ...]` | Show or change this key's settings |
31
+ | `oya sessions` · `oya events` · `oya control` | Durable sessions, lifecycle events, project overview |
32
+ | `oya takeover <id>` · `oya release <id>` · `oya resume <id>` | Human control of a running browser |
33
+ | `oya members` · `oya credential` · `oya webhook` | Team, service credentials, signed webhooks |
34
+ | `oya usage` | What this key has spent |
35
+ | `oya stealth-test [--live]` | Score this deployment against bot detectors |
36
+
37
+ Run `oya help` for every flag.
38
+
39
+ ## Configuration
40
+
41
+ `oya login` saves the key to `~/.oya/config.json` (or under `OYA_CONFIG_HOME`). `OYA_API_KEY` and `OYA_BASE_URL` override it, and so do `--key` and `--url`, so CI needs no login. Add `--json` for machine-readable output.
42
+
43
+ Building an agent in code? Use the SDK: [@oya-ai/browser](https://www.npmjs.com/package/@oya-ai/browser).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@oya-ai/cli",
3
- "version": "0.1.0",
3
+ "version": "1.0.57",
4
4
  "description": "Command line for the Oya browser control plane.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -21,7 +21,7 @@
21
21
  "access": "public"
22
22
  },
23
23
  "devDependencies": {
24
- "@oya-ai/browser": "0.1.0",
24
+ "@oya-ai/browser": "1.0.57",
25
25
  "@types/node": "^20.19.43",
26
26
  "tsup": "^8.0.0",
27
27
  "typescript": "^5.4.0"