@tiny-fish/cli 0.1.2-next.15 → 0.1.2-next.16
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 +87 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# TinyFish CLI
|
|
2
|
+
|
|
3
|
+
Run web automations from your terminal, shell scripts, and CI/CD pipelines.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @tiny-fish/cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Requires Node.js 24+.
|
|
12
|
+
|
|
13
|
+
## Authentication
|
|
14
|
+
|
|
15
|
+
Get your API key from [agent.tinyfish.ai](https://agent.tinyfish.ai).
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Interactive (opens browser, prompts for key)
|
|
19
|
+
tinyfish auth login
|
|
20
|
+
|
|
21
|
+
# CI/CD safe (pipe key via stdin)
|
|
22
|
+
echo $TINYFISH_API_KEY | tinyfish auth set
|
|
23
|
+
|
|
24
|
+
# Or set via environment variable
|
|
25
|
+
export TINYFISH_API_KEY=sk-tinyfish-...
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
### Run an automation
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# Stream steps as they happen (default)
|
|
34
|
+
tinyfish agent run "Find the pricing page" --url https://example.com
|
|
35
|
+
|
|
36
|
+
# Human-readable output
|
|
37
|
+
tinyfish agent run "Find the pricing page" --url https://example.com --pretty
|
|
38
|
+
|
|
39
|
+
# Wait for result without streaming
|
|
40
|
+
tinyfish agent run "Find the pricing page" --url https://example.com --sync
|
|
41
|
+
|
|
42
|
+
# Submit and return immediately (don't wait)
|
|
43
|
+
tinyfish agent run "Find the pricing page" --url https://example.com --async
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Manage runs
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# List recent runs
|
|
50
|
+
tinyfish agent run list --pretty
|
|
51
|
+
|
|
52
|
+
# Filter by status
|
|
53
|
+
tinyfish agent run list --status RUNNING --pretty
|
|
54
|
+
|
|
55
|
+
# Inspect a run
|
|
56
|
+
tinyfish agent run get <run_id> --pretty
|
|
57
|
+
|
|
58
|
+
# Cancel a run
|
|
59
|
+
tinyfish agent run cancel <run_id> --pretty
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Output format
|
|
63
|
+
|
|
64
|
+
By default all commands output newline-delimited JSON to stdout — pipe-friendly for agents and scripts. Add `--pretty` for human-readable output.
|
|
65
|
+
|
|
66
|
+
Errors are JSON to stderr with exit code 1. Ctrl+C during a streaming run cancels it automatically.
|
|
67
|
+
|
|
68
|
+
### Debug
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
TINYFISH_DEBUG=1 tinyfish agent run "..." --url https://example.com
|
|
72
|
+
# or
|
|
73
|
+
tinyfish --debug agent run "..." --url https://example.com
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## CI/CD
|
|
77
|
+
|
|
78
|
+
```yaml
|
|
79
|
+
- name: Run automation
|
|
80
|
+
env:
|
|
81
|
+
TINYFISH_API_KEY: ${{ secrets.TINYFISH_API_KEY }}
|
|
82
|
+
run: |
|
|
83
|
+
tinyfish agent run "Check that the login flow works" \
|
|
84
|
+
--url https://staging.example.com \
|
|
85
|
+
--sync \
|
|
86
|
+
--pretty
|
|
87
|
+
```
|