Skip to content

docs: update docs on configuration and CLI#418

Merged
frrist merged 2 commits intomainfrom
frrist/docs/config-cli
Feb 17, 2026
Merged

docs: update docs on configuration and CLI#418
frrist merged 2 commits intomainfrom
frrist/docs/config-cli

Conversation

@frrist
Copy link
Copy Markdown
Member

@frrist frrist commented Jan 29, 2026

Will maintain this as #417 #416 and #409 land.

@frrist frrist marked this pull request as ready for review February 9, 2026 15:39
@frrist frrist requested a review from alanshaw as a code owner February 9, 2026 15:39
Copy link
Copy Markdown
Member

@alanshaw alanshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 Nice.

Comment thread docs/content/cli/index.md
| `--config <path>` | Config file path. Defaults to `~/.config/piri/config.toml` |
| `--log-level <level>` | Logging level (debug, info, warn, error) |
| `--data-dir <path>` | Storage service data directory |
| `--temp-dir <path>` | Storage service temp directory |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove this, it's basically unused.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, will need to land as a separate change, iirc its still use by a blob store for writes.

Comment thread docs/content/cli/init.md
| Flag | Description |
|------|-------------|
| `--network <network>` | Network to join (`forge-prod` for mainnet, `warm-staging` for calibration) |
| `--data-dir <path>` | Directory for permanent Piri data (blobs, database) |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this will become optional with postgres support?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With just postgres? No, blobs still need a filesystem.

With postgres and s3, also no since the keystore (contains the users wallet for signing) is remaining filesystem-based. At present, we are opting to keep that on the filesystem, outlined in "Security Invariant" section here: #417

## Example

```bash
piri status upgrade-check && piri update
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this work...because piri update says it does not restart the service?

Do you want something more like this?

piri update && piri status upgrade-check && <restart-cmd>

Where restart-cmd is something like sudo systemctl restart piri?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where restart-cmd is something like sudo systemctl restart piri?

Yea, more-or-less. The update command is primarily a convenience command outside of the auto-update flow which is still hidden and undocumented...

@frrist frrist force-pushed the frrist/docs/config-cli branch from 8678013 to d44f547 Compare February 17, 2026 20:49
@frrist frrist changed the base branch from frrist/dyn/cfg to main February 17, 2026 20:49
@frrist frrist merged commit bc0d913 into main Feb 17, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants