garcard Public

Watch 0 Fork 0 Star 0
markdown · 1088 bytes Raw Blame History

garcard

garcard is the in-progress Polkit authentication agent for the gar desktop suite.

Workspace

  1. garcard: daemon runtime
  2. garcard-ipc: shared protocol types
  3. garcardctl: control/debug CLI

Quick Start

  1. cargo run -p garcard -- daemon
  2. cargo run -p garcardctl -- status
  3. cargo run -p garcard -- prompt --mode secret --message "Validation prompt"

Config

Default config path: ~/.config/garcard/config.toml

Environment overrides:

  1. GARCARD_SOCKET
  2. GARCARD_SOCKET_MODE
  3. GARCARD_CONFIG
  4. GARCARD_AGENT_BACKEND
  5. GARCARD_POLKIT_OBJECT_PATH
  6. GARCARD_LOCALE
  7. GARCARD_POLKIT_HELPER_SOCKET
  8. GARCARD_PROMPT_COMMAND
  9. GARCARD_PROMPT_TIMEOUT_SECS
  10. GARCARD_BACKEND_HEALTHCHECK_SECS

Default scaffold file for packaging/integration: config/garcard/config.toml

See examples/config.toml for a minimal local starter file.

GARCARD_PROMPT_COMMAND is optional. If unset, garcard runs the built-in garcard prompt gartk dialog path and falls back to systemd-ask-password when the X11 prompt backend is unavailable.

View source
1 # garcard
2
3 `garcard` is the in-progress Polkit authentication agent for the gar desktop suite.
4
5 ## Workspace
6 1. `garcard`: daemon runtime
7 2. `garcard-ipc`: shared protocol types
8 3. `garcardctl`: control/debug CLI
9
10 ## Quick Start
11 1. `cargo run -p garcard -- daemon`
12 2. `cargo run -p garcardctl -- status`
13 3. `cargo run -p garcard -- prompt --mode secret --message "Validation prompt"`
14
15 ## Config
16 Default config path: `~/.config/garcard/config.toml`
17
18 Environment overrides:
19 1. `GARCARD_SOCKET`
20 2. `GARCARD_SOCKET_MODE`
21 3. `GARCARD_CONFIG`
22 4. `GARCARD_AGENT_BACKEND`
23 5. `GARCARD_POLKIT_OBJECT_PATH`
24 6. `GARCARD_LOCALE`
25 7. `GARCARD_POLKIT_HELPER_SOCKET`
26 8. `GARCARD_PROMPT_COMMAND`
27 9. `GARCARD_PROMPT_TIMEOUT_SECS`
28 10. `GARCARD_BACKEND_HEALTHCHECK_SECS`
29
30 Default scaffold file for packaging/integration: `config/garcard/config.toml`
31
32 See `examples/config.toml` for a minimal local starter file.
33
34 `GARCARD_PROMPT_COMMAND` is optional. If unset, `garcard` runs the built-in
35 `garcard prompt` gartk dialog path and falls back to `systemd-ask-password`
36 when the X11 prompt backend is unavailable.