Name		Name	Last commit message	Last commit date
parent directory ..
src		src
tests		tests
.env.default		.env.default
.env.schema.json		.env.schema.json
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
jsr.jsonc		jsr.jsonc
moon.yml		moon.yml
package.json		package.json
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json
vitest.config.ts		vitest.config.ts

README.md

Description

Scodi Observatory is an analysis module of Scodi, which analyses URLs with MDN HTTP Observatory.

Read more about the description and design of Scodi.

Usage

Standalone

Install the package
```
npm install @scodi/observatory
```
If you are using Yarn, npm < 7 or PNPM < 8, you also have to install Scodi CLI (which is automatically installed in more recent versions of these packages managers):
```
npm install @scodi/cli
```
[Optional] Customize the MDN HTTP Observatory scanner

By default, the scanner used is the public one, but you can use your own.

In this case, you must provide the following env values:
```
SCODI_OBSERVATORY_API_URL=
SCODI_OBSERVATORY_ANALYZE_URL=
```
Start an analysis
```
npx scodi observatory --config '{"host": "ipcc.ch"}'
```
OR
```
npx scodi observatory --config config.json
```
The analysis configuration follows the JSON format and the POST /api/v2/scan specifications.

Github Action

If you're using Github, you can simplify the integration of Scodi in your CI scripts by using the Github Action.