HEDDLE

CLI reference

heddle clone

Shipped
heddle clone [OPTIONS] <REMOTE> <LOCAL>

Clone from a Heddle remote. One of the eight commands that touches the network.

Output text (default) · json

heddle clone brings down a Heddle repository — source history plus the native store. --thread checks a specific thread out afterwards; --depth makes a shallow clone, where 0 means full history.

--recursive (alias --monorepo) resolves the root spool's child tree on a hosted remote and clones every child at its anchored state into its mount path. Hosted and network remotes only.

Arguments

<REMOTE> string required
Remote repository path.
<LOCAL> path required
Local directory to clone into.

Flags

--thread <thread>
Thread to check out after cloning.
--depth <n>
Create a shallow clone with the specified depth. 0 means full history.
--recursive
Clone a whole hosted monorepo: resolve the root spool's child tree and clone every child spool at its anchored state into its mount path. Hosted/network remotes only. Alias: --monorepo.
--insecure
Allow cleartext (non-TLS) connections to non-loopback hosts.
--lazy hidden
Leave blob content absent by design and hydrate it explicitly later. Real, but absent from --help. See heddle help agent-flags.
--filter <SPEC> hidden
Partial-clone filter spec (blob:none only). Real, but absent from --help. See heddle help agent-flags.

Examples

Clone and check out a thread

bash$ heddle clone heddle.sh/acme/api ./api --thread main

See also