Skip to content

Commit ee1f559

Browse files
committed
docs: add package READMEs and presets/types changeset
1 parent 4c92a95 commit ee1f559

File tree

8 files changed

+245
-0
lines changed

8 files changed

+245
-0
lines changed

.changeset/presets-types-update.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"pinorama-presets": minor
3+
"pinorama-types": minor
4+
---
5+
6+
Add searchProperties to presets and PinoramaIntrospection type, add date facet type

packages/pinorama-client/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# pinorama-client
2+
3+
Isomorphic HTTP client for [Pinorama Server](https://pinorama.dev/packages/server). Works in Node.js and the browser.
4+
5+
This package is used internally by Pinorama Transport and Pinorama Studio. Install it directly if you need to build a custom integration.
6+
7+
## Installation
8+
9+
```sh
10+
npm i pinorama-client
11+
```
12+
13+
## Usage
14+
15+
```js
16+
import { PinoramaClient } from "pinorama-client"
17+
18+
const client = new PinoramaClient({
19+
url: "http://localhost:6200/pinorama",
20+
adminSecret: "my-secret"
21+
})
22+
23+
await client.insert([{ level: 30, msg: "hello", time: Date.now() }])
24+
25+
const results = await client.search({ term: "hello", limit: 10 })
26+
```
27+
28+
## API
29+
30+
`insert()` · `search()` · `introspection()` · `styles()` · `clear()` · `stats()` · `context()` · `aggregateByField()` · `mcpStatus()` · `setMcpStatus()`
31+
32+
## Documentation
33+
34+
Full documentation at **[pinorama.dev/packages/client](https://pinorama.dev/packages/client)**.
35+
36+
## License
37+
38+
[MIT](https://github.com/pinoramajs/pinorama/blob/main/LICENSE)

packages/pinorama-mcp/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# pinorama-mcp
2+
3+
A [Model Context Protocol](https://modelcontextprotocol.io/) server that exposes your log database to AI assistants. Ask questions in natural language — the AI reads the schema, picks the right tools, and queries your logs.
4+
5+
## Installation
6+
7+
```sh
8+
npm i pinorama-mcp
9+
```
10+
11+
## Standalone Mode
12+
13+
```sh
14+
pinorama-mcp --url http://localhost:6200/pinorama
15+
```
16+
17+
### Claude Desktop
18+
19+
```json
20+
{
21+
"mcpServers": {
22+
"pinorama": {
23+
"command": "npx",
24+
"args": ["pinorama-mcp", "--url", "http://localhost:6200/pinorama"]
25+
}
26+
}
27+
}
28+
```
29+
30+
### Claude Code
31+
32+
```sh
33+
claude mcp add pinorama -- npx pinorama-mcp --url http://localhost:6200/pinorama
34+
```
35+
36+
## Tools
37+
38+
`get_schema` · `search_logs` · `tail_logs` · `count_logs` · `get_field_values` · `aggregate_by_field` · `get_log_context` · `compare_periods` · `get_stats`
39+
40+
## Documentation
41+
42+
Full documentation at **[pinorama.dev/packages/mcp](https://pinorama.dev/packages/mcp)**.
43+
44+
## License
45+
46+
[MIT](https://github.com/pinoramajs/pinorama/blob/main/LICENSE)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# pinorama-presets
2+
3+
Schema and introspection presets for [Pinorama](https://pinorama.dev). Presets define how logs are indexed, displayed, filtered, and styled.
4+
5+
This package ships with Pinorama Server. You only need to install it directly if you are building a custom preset.
6+
7+
## Built-in Presets
8+
9+
- **`pino`** — Default preset for standard Pino logs (time, level, msg, pid, hostname)
10+
- **`fastify`** — Extended preset for Fastify apps (adds reqId, req.method, req.url, res.statusCode, responseTime)
11+
12+
## Custom Presets
13+
14+
```js
15+
import { createPreset } from "pinorama-presets"
16+
17+
const myPreset = createPreset(schema, introspection)
18+
```
19+
20+
## Documentation
21+
22+
Full documentation at **[pinorama.dev/advanced/presets](https://pinorama.dev/advanced/presets)**.
23+
24+
## License
25+
26+
[MIT](https://github.com/pinoramajs/pinorama/blob/main/LICENSE)

packages/pinorama-server/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# pinorama-server
2+
3+
A [Fastify](https://fastify.dev/) plugin that provides a REST API for storing and searching logs, powered by [Orama](https://askorama.ai/).
4+
5+
Use it as a standalone server or register it into an existing Fastify application. Includes authentication, persistence, auto-save, and a built-in MCP server for AI-powered log analysis.
6+
7+
## Installation
8+
9+
```sh
10+
npm i pinorama-server
11+
```
12+
13+
## Usage
14+
15+
```js
16+
import Fastify from "fastify"
17+
import pinoramaServer from "pinorama-server"
18+
19+
const app = Fastify()
20+
21+
app.register(pinoramaServer, {
22+
adminSecret: "my-secret",
23+
dbPath: "./data/logs.msp"
24+
})
25+
26+
app.listen({ port: 6200 })
27+
```
28+
29+
## REST API
30+
31+
`POST /bulk` · `POST /search` · `GET /introspection` · `GET /styles.css` · `GET /health` · `GET /stats` · `POST /context` · `POST /aggregate/field` · `POST /clear` · `POST /persist`
32+
33+
## Documentation
34+
35+
Full documentation at **[pinorama.dev/packages/server](https://pinorama.dev/packages/server)**.
36+
37+
## License
38+
39+
[MIT](https://github.com/pinoramajs/pinorama/blob/main/LICENSE)

packages/pinorama-studio/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# pinorama-studio
2+
3+
A web-based log explorer for [Pino](https://getpino.io/) logs. Pipe logs from any Node.js process and get full-text search, faceted filtering, keyboard shortcuts, Live Mode, and MCP integration for AI-powered log analysis.
4+
5+
## Installation
6+
7+
```sh
8+
npm i -g pinorama-studio
9+
```
10+
11+
## Usage
12+
13+
```sh
14+
node app.js | pinorama --open
15+
```
16+
17+
## Features
18+
19+
- Full-text search powered by [Orama](https://askorama.ai)
20+
- Faceted filtering (enum, text, date range)
21+
- Live Mode with auto-refresh
22+
- Keyboard-first navigation
23+
- Details panel with JSON tree view
24+
- MCP integration for AI assistants
25+
- Built-in presets for Pino and Fastify logs
26+
- Internationalization (English, Italian)
27+
28+
## Documentation
29+
30+
Full documentation at **[pinorama.dev/packages/studio](https://pinorama.dev/packages/studio)**.
31+
32+
## License
33+
34+
[MIT](https://github.com/pinoramajs/pinorama/blob/main/LICENSE)
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# pinorama-transport
2+
3+
A [Pino transport](https://getpino.io/#/docs/transports) that streams logs to [Pinorama Server](https://pinorama.dev/packages/server). Buffers logs in batches and retries failed inserts with exponential backoff.
4+
5+
## Installation
6+
7+
```sh
8+
npm i pinorama-transport
9+
```
10+
11+
## Usage
12+
13+
```js
14+
import pino from "pino"
15+
16+
const logger = pino({
17+
transport: {
18+
target: "pinorama-transport",
19+
options: {
20+
url: "http://localhost:6200/pinorama"
21+
}
22+
}
23+
})
24+
```
25+
26+
### CLI
27+
28+
```sh
29+
node app.js | pino-pinorama --url http://localhost:6200/pinorama
30+
```
31+
32+
## Documentation
33+
34+
Full documentation at **[pinorama.dev/packages/transport](https://pinorama.dev/packages/transport)**.
35+
36+
## License
37+
38+
[MIT](https://github.com/pinoramajs/pinorama/blob/main/LICENSE)

packages/pinorama-types/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# pinorama-types
2+
3+
Shared TypeScript types for the [Pinorama](https://pinorama.dev) ecosystem.
4+
5+
This is an internal package used by other Pinorama packages. You don't need to install it directly.
6+
7+
## Exports
8+
9+
- `PinoramaIntrospection<T>` — Introspection config (facets, columns, labels, formatters, styles, searchProperties)
10+
- `PinoramaDocumentMetadata` — Internal document metadata (`_pinorama.createdAt`)
11+
12+
## Documentation
13+
14+
Full documentation at **[pinorama.dev](https://pinorama.dev)**.
15+
16+
## License
17+
18+
[MIT](https://github.com/pinoramajs/pinorama/blob/main/LICENSE)

0 commit comments

Comments
 (0)