Skip to content

user-book: doc environment variables #491

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

user-book: doc environment variables #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9ac209
apply
hinto-janai May 28, 2025
0ac3e1f
Merge branch 'main' into env
hinto-janai Jun 4, 2025
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
2 changes: 2 additions & 0 deletions books/user/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

- [Command line](cli.md)

- [Environment variables](env.md)

- [Resources](resources/intro.md)
- [Address](resources/address.md)
- [Disk](resources/disk.md)
Expand Down
16 changes: 16 additions & 0 deletions books/user/src/env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Environment variables

In general, environment variables will override both [config](./config.md) and [CLI](./cli.md) values.

<!--
TODO: flags for:
- randomx
- tracing
- rayon
- tokio
- dirs
-->

| Environment variable | Type | Description |
|---------------------------|------|----------------|
| `$HOME`, `$XDG_DATA_HOME` | Path | `cuprated` will create files/directories within this directory.