@observeone/cli 1.19.1 → 1.20.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.
Files changed (5) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +31 -6
  3. package/dist/README.md +31 -6
  4. package/dist/package.json +9 -1
  5. package/package.json +24 -16
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 ObserveOne
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,8 +1,13 @@
1
1
  # ObserveOne CLI
2
2
 
3
- Artificial intelligence (AI)-powered website monitoring, synthetic testing, and infrastructure-as-code from your terminal.
3
+ [![npm version](https://img.shields.io/npm/v/@observeone/cli.svg)](https://www.npmjs.com/package/@observeone/cli)
4
+ [![CI](https://github.com/Observeone1/ObserveOne-CLI/actions/workflows/ci.yml/badge.svg)](https://github.com/Observeone1/ObserveOne-CLI/actions/workflows/ci.yml)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6
+ [![Node](https://img.shields.io/node/v/@observeone/cli.svg)](package.json)
4
7
 
5
- The `obs` command-line interface (CLI) allows developers and artificial intelligence (AI) agents to manage URL Monitors, Application Programming Interface (API) Checks, Heartbeats, and AI Browser tests using simple commands or declarative JavaScript Object Notation (JSON) configuration files.
8
+ AI-powered website monitoring, synthetic testing, and infrastructure-as-code from your terminal.
9
+
10
+ The `obs` CLI lets developers and AI coding agents manage URL monitors, API checks, heartbeats, and AI browser tests — either through individual commands or a single declarative JSON config.
6
11
 
7
12
  ## Installation
8
13
 
@@ -36,7 +41,7 @@ npm install -g @observeone/cli
36
41
  obs export
37
42
  ```
38
43
 
39
- 4. **Manage a monitor**
44
+ 5. **Manage a monitor**
40
45
  ```bash
41
46
  obs monitor create --name "My Website" --url "https://example.com" --interval "*/5 * * * *"
42
47
  obs monitor list
@@ -492,8 +497,28 @@ The CLI includes a non-blocking background update service that checks for newer
492
497
  - `--version` - Show version number
493
498
  - `--help` - Show help
494
499
 
500
+ ---
501
+
502
+ ## Documentation
503
+
504
+ Deeper docs live in the [`docs/`](docs/) folder:
505
+
506
+ - **Guides**
507
+ - [Getting started](docs/guides/getting-started.md) — install, login, headless agent auth
508
+ - [Config-as-code](docs/guides/config-as-code.md) — `obs apply` / `obs export` IaC workflow
509
+ - [AI agent integration](docs/guides/ai-agent-integration.md) — JSON envelope, agent recipes
510
+ - **Reference**
511
+ - [CLI command reference](docs/reference/cli-commands.md)
512
+ - [Environment variables](docs/reference/environment-variables.md)
513
+ - [JSON schema](docs/reference/json-schema.md)
514
+ - **Architecture** (for contributors)
515
+ - [Implementation summary](docs/architecture/implementation-summary.md)
516
+ - [E2E testing framework](docs/architecture/e2e-testing.md)
517
+
518
+ ## Contributing
519
+
520
+ Contributions are welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for dev setup, test commands, and the PR workflow.
521
+
495
522
  ## License
496
- MIT
497
523
 
498
- ---
499
- **Happy Testing!**
524
+ Released under the [MIT License](LICENSE).
package/dist/README.md CHANGED
@@ -1,8 +1,13 @@
1
1
  # ObserveOne CLI
2
2
 
3
- Artificial intelligence (AI)-powered website monitoring, synthetic testing, and infrastructure-as-code from your terminal.
3
+ [![npm version](https://img.shields.io/npm/v/@observeone/cli.svg)](https://www.npmjs.com/package/@observeone/cli)
4
+ [![CI](https://github.com/Observeone1/ObserveOne-CLI/actions/workflows/ci.yml/badge.svg)](https://github.com/Observeone1/ObserveOne-CLI/actions/workflows/ci.yml)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6
+ [![Node](https://img.shields.io/node/v/@observeone/cli.svg)](package.json)
4
7
 
5
- The `obs` command-line interface (CLI) allows developers and artificial intelligence (AI) agents to manage URL Monitors, Application Programming Interface (API) Checks, Heartbeats, and AI Browser tests using simple commands or declarative JavaScript Object Notation (JSON) configuration files.
8
+ AI-powered website monitoring, synthetic testing, and infrastructure-as-code from your terminal.
9
+
10
+ The `obs` CLI lets developers and AI coding agents manage URL monitors, API checks, heartbeats, and AI browser tests — either through individual commands or a single declarative JSON config.
6
11
 
7
12
  ## Installation
8
13
 
@@ -36,7 +41,7 @@ npm install -g @observeone/cli
36
41
  obs export
37
42
  ```
38
43
 
39
- 4. **Manage a monitor**
44
+ 5. **Manage a monitor**
40
45
  ```bash
41
46
  obs monitor create --name "My Website" --url "https://example.com" --interval "*/5 * * * *"
42
47
  obs monitor list
@@ -492,8 +497,28 @@ The CLI includes a non-blocking background update service that checks for newer
492
497
  - `--version` - Show version number
493
498
  - `--help` - Show help
494
499
 
500
+ ---
501
+
502
+ ## Documentation
503
+
504
+ Deeper docs live in the [`docs/`](docs/) folder:
505
+
506
+ - **Guides**
507
+ - [Getting started](docs/guides/getting-started.md) — install, login, headless agent auth
508
+ - [Config-as-code](docs/guides/config-as-code.md) — `obs apply` / `obs export` IaC workflow
509
+ - [AI agent integration](docs/guides/ai-agent-integration.md) — JSON envelope, agent recipes
510
+ - **Reference**
511
+ - [CLI command reference](docs/reference/cli-commands.md)
512
+ - [Environment variables](docs/reference/environment-variables.md)
513
+ - [JSON schema](docs/reference/json-schema.md)
514
+ - **Architecture** (for contributors)
515
+ - [Implementation summary](docs/architecture/implementation-summary.md)
516
+ - [E2E testing framework](docs/architecture/e2e-testing.md)
517
+
518
+ ## Contributing
519
+
520
+ Contributions are welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for dev setup, test commands, and the PR workflow.
521
+
495
522
  ## License
496
- MIT
497
523
 
498
- ---
499
- **Happy Testing!**
524
+ Released under the [MIT License](LICENSE).
package/dist/package.json CHANGED
@@ -1,12 +1,20 @@
1
1
  {
2
2
  "name": "@observeone/cli",
3
- "version": "1.19.1",
3
+ "version": "1.20.0",
4
4
  "type": "module",
5
5
  "description": "ObserveOne CLI - AI-powered website monitoring and testing from the command line",
6
6
  "main": "dist/index.js",
7
7
  "bin": {
8
8
  "obs": "dist/index.js"
9
9
  },
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/Observeone1/ObserveOne-CLI.git"
13
+ },
14
+ "homepage": "https://www.observeone.com/cli",
15
+ "bugs": {
16
+ "url": "https://github.com/Observeone1/ObserveOne-CLI/issues"
17
+ },
10
18
  "scripts": {
11
19
  "start": "node index.js"
12
20
  },
package/package.json CHANGED
@@ -1,12 +1,34 @@
1
1
  {
2
2
  "name": "@observeone/cli",
3
- "version": "1.19.1",
3
+ "version": "1.20.0",
4
4
  "type": "module",
5
5
  "description": "ObserveOne CLI - AI-powered website monitoring and testing from the command line",
6
6
  "main": "dist/index.js",
7
7
  "bin": {
8
8
  "obs": "dist/index.js"
9
9
  },
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/Observeone1/ObserveOne-CLI.git"
13
+ },
14
+ "homepage": "https://www.observeone.com/cli",
15
+ "bugs": {
16
+ "url": "https://github.com/Observeone1/ObserveOne-CLI/issues"
17
+ },
18
+ "scripts": {
19
+ "build": "node scripts/build.js",
20
+ "dev": "tsx src/index.ts",
21
+ "check": "tsc --noEmit",
22
+ "lint": "eslint \"src/**/*.ts\" \"e2e/**/*.ts\"",
23
+ "format": "prettier --write \"src/**/*.ts\" \"e2e/**/*.ts\"",
24
+ "format:check": "prettier --check \"src/**/*.ts\" \"e2e/**/*.ts\"",
25
+ "test": "vitest run && tsx e2e/run-tests.ts",
26
+ "test:unit": "vitest run",
27
+ "test:e2e": "tsx e2e/run-tests.ts",
28
+ "knip": "knip",
29
+ "prepublishOnly": "npm run build",
30
+ "prepare": "husky"
31
+ },
10
32
  "keywords": [
11
33
  "observeone",
12
34
  "obs",
@@ -52,19 +74,5 @@
52
74
  ],
53
75
  "lint-staged": {
54
76
  "*.ts": "prettier --write"
55
- },
56
- "scripts": {
57
- "start": "node server.js",
58
- "start:dev": "tsx src/index.ts",
59
- "build": "node scripts/build.js",
60
- "dev": "tsx src/index.ts",
61
- "check": "tsc --noEmit",
62
- "lint": "eslint \"src/**/*.ts\" \"e2e/**/*.ts\"",
63
- "format": "prettier --write \"src/**/*.ts\" \"e2e/**/*.ts\"",
64
- "format:check": "prettier --check \"src/**/*.ts\" \"e2e/**/*.ts\"",
65
- "test": "vitest run && tsx e2e/run-tests.ts",
66
- "test:unit": "vitest run",
67
- "test:e2e": "tsx e2e/run-tests.ts",
68
- "knip": "knip"
69
77
  }
70
- }
78
+ }