Skip to content

docs: update docs on configuration and CLI #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
frrist wants to merge 1 commit into
base: frrist/dyn/cfg
Choose a base branch
from
Draft

docs: update docs on configuration and CLI #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/content/cli/client/admin/config/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# get

Get a specific dynamic configuration value.

## Usage

```
piri client admin config get <key>
```

## Arguments

| Argument | Description |
|----------|-------------|
| `<key>` | The configuration key to retrieve |

## Example

```bash
piri client admin config get pdp.aggregation.manager.poll_interval
```

```
30s
```

See [Dynamic Configuration](../../../../configuration/index.md#dynamic-configuration) for the list of available keys.
27 changes: 27 additions & 0 deletions docs/content/cli/client/admin/config/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# config

Manage dynamic configuration values at runtime.

## Usage

```
piri client admin config [command]
```

## Subcommands

### [list](list.md)

List all dynamic configuration values.

### [get](get.md)

Get a specific configuration value.

### [set](set.md)

Set a configuration value.

### [reload](reload.md)

Reload configuration from file.
24 changes: 24 additions & 0 deletions docs/content/cli/client/admin/config/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# list

List all dynamic configuration values.

## Usage

```
piri client admin config list
```

## Example

```bash
piri client admin config list
```

```json
{
"pdp.aggregation.manager.batch_size": 10,
"pdp.aggregation.manager.poll_interval": "30s"
}
```

See [Dynamic Configuration](../../../../configuration/index.md#dynamic-configuration) for the list of available keys.
25 changes: 25 additions & 0 deletions docs/content/cli/client/admin/config/reload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# reload

Reload configuration from the config file.

## Usage

```
piri client admin config reload
```

## Example

```bash
piri client admin config reload
```

```
Configuration reloaded from file
{
"pdp.aggregation.manager.batch_size": 10,
"pdp.aggregation.manager.poll_interval": "1m0s"
}
```

See [Dynamic Configuration](../../../../configuration/index.md#dynamic-configuration) for the list of available keys.
34 changes: 34 additions & 0 deletions docs/content/cli/client/admin/config/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# set

Set a dynamic configuration value.

## Usage

```
piri client admin config set <key> <value> [flags]
```

## Arguments

| Argument | Description |
|----------|-------------|
| `<key>` | The configuration key to set |
| `<value>` | The new value |

## Flags

| Flag | Description |
|------|-------------|
| `--persist` | Persist the change to the config file |

## Example

```bash
piri client admin config set pdp.aggregation.manager.poll_interval 1m
```

```
pdp.aggregation.manager.poll_interval updated
```

See [Dynamic Configuration](../../../../configuration/index.md#dynamic-configuration) for the list of available keys.
19 changes: 19 additions & 0 deletions docs/content/cli/client/admin/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# admin

Administrative operations for managing a running Piri node.

## Usage

```
piri client admin [command]
```

## Subcommands

### [config](config/index.md)

Manage dynamic configuration.

### [log](log/index.md)

Manage logging levels.
23 changes: 23 additions & 0 deletions docs/content/cli/client/admin/log/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# log

Manage logging levels for a running Piri node.

## Usage

```
piri client admin log [command]
```

## Subcommands

### [list](list.md)

List all log systems and their current levels.

### [set](set.md)

Set a log level for one system or all systems.

### [set-regex](set-regex.md)

Set log level for subsystems matching a regex pattern.
25 changes: 25 additions & 0 deletions docs/content/cli/client/admin/log/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# list

List all log systems and their current levels.

## Usage

```
piri client admin log list
```

## Example

```bash
piri client admin log list
```

```json
{
"piri/pdp": "info",
"piri/storage": "info",
"piri/retrieval": "debug",
"piri/claims": "info",
"piri/replicator": "warn"
}
```
30 changes: 30 additions & 0 deletions docs/content/cli/client/admin/log/set-regex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# set-regex

Set log level for subsystems matching a regex pattern.

## Usage

```
piri client admin log set-regex <level> <expression>
```

## Arguments

| Argument | Description |
|----------|-------------|
| `<level>` | Log level to set (debug, info, warn, error) |
| `<expression>` | Regular expression pattern to match system names |

## Example

```bash
piri client admin log set-regex debug "piri/pdp.*"
```

```json
{
"piri/pdp": "debug",
"piri/pdp/scheduler": "debug",
"piri/pdp/aggregation": "debug"
}
```
28 changes: 28 additions & 0 deletions docs/content/cli/client/admin/log/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# set

Set a log level for one system or all systems.

## Usage

```
piri client admin log set <level> [system]
```

## Arguments

| Argument | Description |
|----------|-------------|
| `<level>` | Log level to set (debug, info, warn, error) |
| `[system]` | Specific system name. If omitted, sets level for all systems |

## Example

```bash
piri client admin log set debug piri/pdp
```

```json
{
"piri/pdp": "debug"
}
```
31 changes: 31 additions & 0 deletions docs/content/cli/client/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# client

Interact with a running Piri node.

All client commands require a running Piri server and authenticate using JWT tokens signed with your node's identity key. Pass the same `--config` file you used with `piri serve` - this provides both the server address and your identity key for authentication:

```bash
piri --config=config.toml client admin config list
```

## Usage

```
piri client [command] [flags]
```

## Flags

| Flag | Description | Default |
|------|-------------|---------|
| `--node-url <url>` | URL of a Piri node | `http://localhost:3000` |

## Subcommands

### [admin](admin/index.md)

Administrative operations (logs, config).

### [pdp](pdp/index.md)

PDP (Provable Data Possession) operations.
15 changes: 15 additions & 0 deletions docs/content/cli/client/pdp/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# pdp

PDP (Provable Data Possession) operations.

## Usage

```
piri client pdp [command]
```

## Subcommands

### [proofset](proofset/index.md)

Manage proof sets.
15 changes: 15 additions & 0 deletions docs/content/cli/client/pdp/proofset/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# proofset

Manage proof sets.

## Usage

```
piri client pdp proofset [command]
```

## Subcommands

### [state](state.md)

Get the current state of a proof set.
50 changes: 50 additions & 0 deletions docs/content/cli/client/pdp/proofset/state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# state

Get the current state of a proof set.

## Usage

```
piri client pdp proofset state [flags]
```

## Flags

| Flag | Description |
|------|-------------|
| `--proof-set <id>` | The proof set ID to query |
| `--json` | Output in JSON format |

## Example

```bash
piri client pdp proofset state --proof-set 123
```

```
Proof Set State
===============
Proof Set ID: 123
Proving Period: 2880 epochs
Challenge Window: 60 epochs

Owners
------
Owner: 0x1234...abcd

Status
------
Initialized: true
Current Epoch: 4052160

Challenge State
---------------
In Challenge Window: false
Has Proven: true
Next Challenge: 2025-01-28 14:30:00 UTC (estimated)

On-Chain State
--------------
Root Count: 42
Total Data Size: 1.2 TiB
```
Loading