Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 1.95 KB

CONFIG.md

File metadata and controls

58 lines (45 loc) · 1.95 KB
Raw

Config Info

Config info is prioritized in the order of

  1. arguments
  2. environmental variables
  3. config file
  4. defaults

Args

Use cargo prebuilt --help.

Environmental Vars

Use cargo prebuilt --help.

File

Important

The config file is ignored when using the --ci flag.

[!WARNING] Config files are not stable between any versions.

Config Directory ($CONFIG)

[prebuilt]
target = "$TARGET"          # Target to download for
safe = true|false           # Prevent the overwriting of binaires (Except when--ci is used)
index_key = "$INDEX_KEY"    # Index to use
no_sig = true|false         # Do not verify info.json
no_hash = true|false        # Do not hash downloaded blobs
hash_bins = true|false      # Hash extracted bins
path = "$PATH"              # Absolute path to where the binaries will be installed
report_path = "$PATH"       # Absolute path to where the reports will be put
no_create_path = true|false # Do not create paths that do not exist
reports = ["$REPORT_TYPE"]  # Reports to download
out = true|false            # Print out event info (See EVENTS.md)
color = true|false          # Should CLI colors be on
no_color = true|false       # Should CLI colors be off

[index.$INDEX_KEY]          # Add a public verifying key for an index
index = "$INDEX"            # Index string
pub_key = ["$PUBLIC_KEY_1"] # (Optional) Public minisign verifying key for index
auth = "$TOKEN"             # (Optional) Auth token to use for this index.

Ref

  • $TARGET is a rustc target string. EX: aarch64-apple-darwin
  • $INDEX is a custom index string. EX: gh-pub:github.com/cargo-prebuilt/index
  • $INDEX_KEY is any string.
  • $TOKEN is a auth token for the index.
  • $PATH is a absolute path. EX: /User/devops/.cargo/bin
  • $REPORT_TYPE is a type of report. Report Types
  • $PUBLIC_KEY is a public minisign key. (See keys/cargo-prebuilt-index.pub)