libra fetch
Command reference for `libra fetch`
Download objects and update remote-tracking refs from another repository.
Synopsis
libra fetch [OPTIONS] [<repository> [<refspec>]]Description
libra fetch contacts a remote repository, negotiates which objects the local store is
missing, downloads them as a pack file, indexes the pack, and updates the corresponding
remote-tracking refs (e.g. refs/remotes/origin/main). It never modifies the working
tree or the current branch -- use libra pull or libra merge for that.
When invoked with no arguments, it fetches from the current branch's configured upstream.
When --all is given, every configured remote is fetched in sequence. When a specific
<repository> is named, only that remote is contacted. An optional <refspec> narrows
the fetch to a single branch.
Fetch supports SSH, HTTPS, local file, and git:// transports. Vault-backed SSH keys
are loaded automatically when configured via vault.ssh.<remote>.privkey.
Options
| Flag / Argument | Description | Example |
|---|---|---|
<repository> | Remote name or URL to fetch from. When omitted, uses the current branch's upstream remote. | libra fetch origin |
<refspec> | Branch name to fetch. Requires <repository>. When omitted, all branches from the remote are fetched. | libra fetch origin main |
-a, --all | Fetch from every configured remote. Conflicts with <repository>. | libra fetch --all |
--depth <N> | Limit fetching to the specified number of commits from the tip of each remote branch (shallow fetch). Public stable flag. | libra fetch origin --depth 1 |
--tags | Fetch every tag from the remote into the local refs/tags/* (overrides the default auto-follow and remote.<name>.tagOpt). | libra fetch origin --tags |
--no-tags | Fetch no tags at all, not even tags reachable from fetched commits (overrides the default auto-follow). | libra fetch origin --no-tags |
--no-auto-gc | Do not run a repacking/gc pass after fetching. Accepted no-op for Git parity: Libra's fetch never triggers an automatic gc, so there is nothing to disable. | libra fetch origin --no-auto-gc |
--no-progress | Do not show the progress meter (the "Receiving objects" spinner / remote progress) on stderr, matching git fetch --no-progress. | libra fetch origin --no-progress |
-p, --prune | After the fetch, delete remote-tracking refs under refs/remotes/<remote>/* that the remote no longer advertises (reusing remote prune's stale classification). Deletions plus an audit reflog entry run in one transaction. Local branches, tags, refs/remotes/<remote>/HEAD, and other remotes are never touched. With --dry-run, the stale refs are reported but not deleted. | libra fetch origin -p |
--no-prune | Do not prune remote-tracking refs (the default). --prune/--no-prune form a last-one-wins toggle: when both are given, the last on the command line wins (Git semantics). | libra fetch origin --no-prune |
--notes | Also import the file-dependency graph (refs/notes/deps, lore.md 3.2) from the remote over a dedicated side-channel. Default OFF (Git never auto-fetches notes). v1 travels notes only from a local Libra source; a network or plain-Git remote emits an honest "not supported yet" warning and imports no graph (deferred, D17). Import union-merges into any local edges and re-validates every endpoint, and is per-note fault-tolerant (a malformed note, or one whose commit is absent locally, is skipped with a warning, never aborting the fetch). Persist the opt-in per remote with remote.<name>.fetchNotesDeps=true. | libra fetch origin --notes |
-f, --force | Allow non-fast-forward updates and overwrite (clobber) a local tag that points elsewhere. Forced updates are marked + in --porcelain / (forced update) in human output. | libra fetch origin --tags --force |
--dry-run | Preview the remote-tracking ref updates the fetch would produce without downloading any objects or writing refs, reflog, or FETCH_HEAD. | libra fetch origin --dry-run |
--append | Append fetched ref records to .libra/FETCH_HEAD instead of overwriting it. (-a is reserved for --all.) | libra fetch origin --append |
-v, --verbose | Announce the remote being contacted on stderr; the stdout result contract is unchanged. | libra fetch origin -v |
--porcelain | Print a machine-readable <flag> <old-oid> <new-oid> <local-ref> line per ref update. Mutually exclusive with --json. | libra fetch origin --porcelain |
--json | Emit structured JSON envelope to stdout (global flag). | libra --json fetch origin |
--machine | Compact single-line JSON; suppresses progress (global flag). | libra --machine fetch origin |
--progress none | Suppress NDJSON progress events on stderr in JSON mode. | libra --json fetch origin --progress none |
--quiet | Suppress human-readable output. | libra fetch --quiet |
Common Commands
libra fetch
libra fetch origin
libra fetch origin main
libra fetch --all
libra fetch origin --depth 1 # shallow fetch
libra fetch origin --tags # also fetch all tags into refs/tags/*
libra fetch --all --depth 3 # shallow across all remotes
libra fetch origin --dry-run # preview ref updates, write nothing
libra fetch origin --porcelain # machine-readable per-ref lines
libra fetch origin -v # announce the remote on stderr
libra fetch origin --append # accumulate into FETCH_HEAD
libra --json fetch origin
libra --json fetch origin --progress noneNetwork timeouts
A network fetch (http(s)://, git://, ssh://) is bounded by these timeouts
so a dead or black-holed remote cannot hang the command forever:
| Timeout | Default | What it bounds |
|---|---|---|
| connect | 30s | the TCP (+ TLS) handshake when opening the connection |
| idle | 60s | the longest gap with no bytes arriving during ref advertisement or pack streaming (it resets whenever data arrives, so a slow-but-steady transfer is not cut off) |
| first-byte | 30s | the wait from sending the want list to the first response byte (NAK / pack header) — catches a server that accepts the negotiation but never starts streaming, sooner than the idle timeout would. Applied to git://; http(s)/ssh bound the first response through their own read timeouts |
Each is resolved in this precedence order:
- an environment variable in milliseconds —
LIBRA_FETCH_CONNECT_TIMEOUT_MS,LIBRA_FETCH_IDLE_TIMEOUT_MS,LIBRA_FETCH_FIRST_BYTE_TIMEOUT_MS; - a config value in whole seconds —
fetch.<remote>.connectTimeout/fetch.<remote>.idleTimeout/fetch.<remote>.firstByteTimeout, then the un-scopedfetch.connectTimeout/fetch.idleTimeout/fetch.firstByteTimeout; - the built-in default above.
# Give a flaky remote longer to connect, for this remote only.
libra config fetch.origin.connectTimeout 90
# One-off override (milliseconds) without touching config.
LIBRA_FETCH_IDLE_TIMEOUT_MS=120000 libra fetch originLocal (file:// / path) remotes read from disk and are not subject to network
timeouts. git:// connections are now bounded by all three timeouts (previously
they had none). An unparseable env/config value is ignored rather than applied,
so a typo never leaves a fetch with a zero or nonsensical timeout.
FETCH_HEAD
Every successful fetch records the fetched refs in .libra/FETCH_HEAD, one
<oid>\tnot-for-merge\tbranch '<name>' of <url> line per ref. Libra never
designates a merge target (merge with libra pull), so every line is marked
not-for-merge. --append accumulates into the file instead of overwriting it;
--dry-run writes nothing.
Human Output
Successful human mode prints a compact summary:
From /path/to/remote.git
* [new ref] origin/main
32 objects fetchedWhen nothing changed:
From /path/to/remote.git
Already up to date with 'origin'Structured Output (JSON examples)
--jsonwrites one success envelope tostdout--machinewrites the same schema as compact single-line JSONstdoutis reserved for the final envelope only
Top-Level Schema
all: whether--allwas usedrequested_remote: explicit remote name, ornullfor--allrefspec: requested branch/refspec when providedremotes[]: per-remote fetch results
Per-Remote Result Schema
remote: logical remote nameurl: normalized remote URL/pathrefs_updated[]: updated remote-tracking refsobjects_fetched: object count parsed from the received packbytes_received: byte size of the received pack stream (0 when nothing was transferred)
Refs Updated Schema
remote_ref: fully qualified local remote-tracking ref, e.g.refs/remotes/origin/mainold_oid: previous object id, ornullwhen the ref is newnew_oid: fetched object id
Example (single remote):
{
"ok": true,
"command": "fetch",
"data": {
"all": false,
"requested_remote": "origin",
"refspec": null,
"remotes": [
{
"remote": "origin",
"url": "[email protected]:user/repo.git",
"refs_updated": [
{
"remote_ref": "refs/remotes/origin/main",
"old_oid": "abc1234...",
"new_oid": "def5678..."
}
],
"objects_fetched": 32,
"bytes_received": 4096
}
]
}
}Example (already up to date):
{
"ok": true,
"command": "fetch",
"data": {
"all": false,
"requested_remote": "origin",
"refspec": null,
"remotes": [
{
"remote": "origin",
"url": "[email protected]:user/repo.git",
"refs_updated": [],
"objects_fetched": 0,
"bytes_received": 0
}
]
}
}Progress
- In
--jsonmode, progress defaults to NDJSON events onstderr - Use
--progress noneto keepstderrquiet in JSON mode --machinedisables progress automatically and keepsstderrclean on success
Design Rationale
Pruning is opt-in, not the default
Git ships fetch.prune = true as a recommended default because stale remote-tracking
refs accumulate silently. Libra does not prune by default for two reasons: (1) in
agent-driven workflows, stale tracking refs can serve as useful historical anchors for
diffing against a previous remote state, and (2) destructive ref cleanup should be a
deliberate choice. Pruning is therefore opt-in via --prune/-p (or the standalone
libra remote prune <name>). --no-prune is the default; --prune/--no-prune form a
last-one-wins toggle, matching Git.
When --prune is given, after the fetch completes Libra removes every
refs/remotes/<remote>/* ref the remote no longer advertises, classified by the same rule
remote prune uses. The deletions and a non-lossy audit reflog entry (<old> -> 0…0) run
in a single transaction, so a mid-prune failure rolls back every deletion. --dry-run
reports the stale refs without writing. Documented narrowings versus Git: pruning is
full-remote scoped (it cleans every stale tracking ref for the remote, like
remote prune, rather than restricting to an explicit refspec), it is skipped entirely
when the remote advertises no refs at all (so a transient empty advertisement cannot wipe
every tracking ref), and pruned refs never appear in FETCH_HEAD (which records only
fetched refs).
Shallow fetch (--depth) is exposed as a stable flag
libra fetch --depth N is a public stable flag (audited C3 in
docs/development/commands/clone.md).
The internal fetch_repository(..., depth) plumbing has supported shallow fetch
for some time; C3 surfaces it on the CLI and binds the contract:
--depth Nlimits fetching to the latestNcommits per remote branch.- It composes with
--all: a shallow fetch across all configured remotes islibra fetch --all --depth N. - A full-history fetch followed by
fetch --depth Nis idempotent. - Re-fetching an already-shallow repository at the same depth is also
idempotent: Libra persists server-advertised shallow boundaries in
.libra/shallowand sends them during later upload-pack negotiation. - Sparse checkout (
clone --sparse) is not part of this contract — seedocs/development/commands/_compatibility.mdfor why sparse-checkout is intentionally deferred.
Shallow fetch does introduce the usual Git "shallow boundary" caveats (blame, log, merge-base computation may not see commits beyond the boundary). That trade-off is a user-visible knob, not a default — full-history fetch remains the default and the recommended posture for monorepo and AI-agent workflows. Tiered cloud storage (S3/R2 + LRU caching) remains the bandwidth solution for the cases where full history is wanted.
Why JSON progress on stderr?
Structured progress events (object counts, bytes received) are emitted as NDJSON lines
on stderr so that agent frameworks can parse real-time progress without interfering with
the final result envelope on stdout. This follows the Unix convention of separating status
information (stderr) from data output (stdout). The --progress none flag allows callers
that do not need progress to suppress it entirely, and --machine mode disables progress
by default for maximum script friendliness.
Parameter Comparison: Libra vs Git vs jj
| Parameter | Libra | Git | jj |
|---|---|---|---|
| Fetch upstream | libra fetch | git fetch | jj git fetch |
| Named remote | libra fetch origin | git fetch origin | jj git fetch --remote origin |
| Single branch | libra fetch origin main | git fetch origin main | jj git fetch --remote origin --branch main |
| All remotes | libra fetch --all | git fetch --all | jj git fetch --all-remotes |
| Prune stale refs | libra fetch -p / libra remote prune <name> | git fetch --prune | Automatic |
| Shallow fetch | libra fetch --depth N | git fetch --depth N | Not supported |
| Dry-run preview | libra fetch --dry-run | git fetch --dry-run | Not supported |
| Porcelain output | libra fetch --porcelain | git fetch --porcelain | No |
| Append FETCH_HEAD | libra fetch --append | git fetch --append | No |
| Verbose diagnostics | libra fetch -v | git fetch -v | No |
| Tag auto-follow (default) | Tags reachable from fetched commits are followed automatically (via include-tag) | Same (default) | Automatic |
| Tag fetch control | libra fetch --tags / --no-tags; remote.<name>.tagOpt | git fetch --tags / --no-tags; remote.<name>.tagOpt | Automatic |
| Force fetch | libra fetch -f / --force (non-FF + tag clobber) | git fetch --force | Automatic |
| Atomic / refmap | Not supported (deferred) | git fetch --atomic / --refmap | No |
| Structured output | --json / --machine | No | No |
| Progress events | NDJSON on stderr | Text on stderr | Text on stderr |
Error Handling
| Scenario | StableErrorCode | Exit | Hint |
|---|---|---|---|
| No configured upstream / detached HEAD | LBR-REPO-003 | 128 | "checkout a branch or specify a remote" |
| Remote not found | LBR-CLI-003 | 129 | "use 'libra remote -v' to see configured remotes" |
| Remote branch not found | LBR-CLI-003 | 129 | "verify the remote branch name and try again" |
| Invalid remote spec (missing repo, malformed URL, unsupported scheme) | LBR-CLI-003 or LBR-REPO-001 | 129 / 128 | Varies by cause |
| Authentication failure during discovery | LBR-AUTH-002 | 128 | "check SSH key / HTTP credentials and repository access rights" |
| Network timeout / transport failure | LBR-NET-001 | 128 | "check network connectivity and retry" |
| Packet / sideband / checksum / pack protocol failure | LBR-NET-002 | 128 | "the remote did not respond correctly" |
| Object format mismatch | LBR-REPO-003 | 128 | "remote uses a different hash algorithm" |
| Failed to create pack directory | LBR-IO-002 | 128 | "check filesystem permissions" |
| Failed to write pack/index/refs | LBR-IO-002 | 128 | "check filesystem permissions and disk space" |
| Local state corruption | LBR-REPO-002 | 128 | "inspect repository state and object integrity" |