@exayard/cli 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 +75 -0
- package/dist/bin.d.ts +1 -0
- package/dist/bin.js +707 -0
- package/dist/index.d.ts +38 -0
- package/dist/index.js +612 -0
- package/package.json +33 -0
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# @exayard/cli
|
|
2
|
+
|
|
3
|
+
Official command-line interface for the [Exayard](https://exayard.com) API —
|
|
4
|
+
AI-powered construction takeoffs, estimates, and bids. Built for humans and
|
|
5
|
+
agents alike: every command supports `--json` for machine-readable output and
|
|
6
|
+
returns stable exit codes.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g @exayard/cli
|
|
12
|
+
# or run without installing:
|
|
13
|
+
npx @exayard/cli --help
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Authenticate
|
|
17
|
+
|
|
18
|
+
Generate an API key with the minimum scopes you need at
|
|
19
|
+
[exayard.com/settings/developer](https://exayard.com/settings/developer), then:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
exayard login --api-key sk_live_...
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Credentials are saved to `~/.exayard/config.json`. You can also pass
|
|
26
|
+
`--api-key` / `--org` per call, or set `EXAYARD_API_KEY`.
|
|
27
|
+
|
|
28
|
+
## Commands
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
Projects:
|
|
32
|
+
exayard projects list --org org_...
|
|
33
|
+
exayard projects create --name "<name>"
|
|
34
|
+
exayard projects archive <project_id>
|
|
35
|
+
|
|
36
|
+
Webhooks:
|
|
37
|
+
exayard webhooks list
|
|
38
|
+
exayard webhooks create --url <https://...> --events "project.created,bid.generated"
|
|
39
|
+
exayard webhooks delete <endpoint_id>
|
|
40
|
+
exayard webhooks verify --signature ... --secret ... < body.json
|
|
41
|
+
exayard listen --forward-to http://localhost:... (experimental)
|
|
42
|
+
|
|
43
|
+
Help / misc:
|
|
44
|
+
exayard help-search "how do I run a takeoff"
|
|
45
|
+
exayard init Drop agents.md into the cwd
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Global flags
|
|
49
|
+
|
|
50
|
+
| Flag | Description |
|
|
51
|
+
|------|-------------|
|
|
52
|
+
| `--json` | Emit machine-readable JSON and suppress prose |
|
|
53
|
+
| `--api-key <key>` | Override saved credentials for this call |
|
|
54
|
+
| `--org <id>` | Override the saved organization ID |
|
|
55
|
+
|
|
56
|
+
### Exit codes
|
|
57
|
+
|
|
58
|
+
| Code | Meaning |
|
|
59
|
+
|------|---------|
|
|
60
|
+
| `0` | Success |
|
|
61
|
+
| `1` | Operation failed (expected, actionable) |
|
|
62
|
+
| `2` | Usage error (bad flags) |
|
|
63
|
+
| `3` | Network / unexpected error |
|
|
64
|
+
|
|
65
|
+
Agents should branch on the exit code and parse `--json` output.
|
|
66
|
+
|
|
67
|
+
## Links
|
|
68
|
+
|
|
69
|
+
- API reference: <https://developers.exayard.com/api-reference>
|
|
70
|
+
- OpenAPI spec: <https://api.exayard.com/v1/openapi.json>
|
|
71
|
+
- MCP discovery: <https://api.exayard.com/.well-known/mcp.json>
|
|
72
|
+
|
|
73
|
+
## License
|
|
74
|
+
|
|
75
|
+
MIT
|
package/dist/bin.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|