Artifact 6023684d87cbd83e2fdda21e1c0d5dcf3bb619e4a9e34803422c6b37305c4beb:
- File
docs/site/content/docs/reference/sdk/cli/api.md
— part of check-in
[e2a2f28861]
at
2026-04-26 07:52:11
on branch trunk
— docs site + landing + Cloudflare auto-deploy (#6)
* design: docs site + landing page + Cloudflare auto-deploy
Mirror dagnats's docs/landing infrastructure for libfossil: a single-page landing at site/index.html (forked CSS/HTML, content rewritten), a Hugo + Hextra docs site at docs/site/, gomarkdoc-generated SDK reference under docs/site/content/docs/reference/sdk/, llms.txt artifacts, and a wrangler.jsonc that lets Cloudflare's git integration auto-deploy on push to main. Existing docs/*.md files move under docs/site/content/docs/.
* design: correct landing-page path to Hugo layout override
dagnats's working landing page lives at docs/site/layouts/index.html (a Hugo home-page layout override), not at site/index.html. The top-level site/index.html in dagnats is an older draft that the build pipeline ignores. Match the working setup.
* design: align visual system + section list with live dagnats landing
The earlier description came from dagnats's stale top-level site/index.html (JetBrains Mono + Instrument Serif italic + ember/teal accents, 8 sections). The live Hugo layout that actually serves at / uses Geist Mono only, prefers-color-scheme dual-mode (warm cream / warm dark), a single ember accent, and 7 sections (Install, What it is, Why you might want it, How it fits together, Compared to neighbors, What it is not, Get going). Update the spec to match what we are actually mirroring.
* design: drop SDK regen from CF build to match dagnats exactly
Earlier draft had CF install Go + gomarkdoc and re-run docs-gen-sdk on every deploy. dagnats does not do that; it relies on the pre-commit hook to keep committed SDK pages in sync, and ships only Hugo + llms-gen + hugo --minify in the CF build. Match that: smaller, faster CF build, no Go-runtime assumption about Workers Builds, and a true 1:1 mirror.
* plan: docs site + landing + CF auto-deploy implementation steps
11 tasks covering Hugo+Hextra bootstrap, content moves, gomarkdoc SDK generation with pre-commit drift check, llms.txt artifacts, Makefile targets, landing page fork from dagnats's live Hugo home layout, wrangler.jsonc for CF Workers Static Assets, README update, and PR creation.
* docs(site): bootstrap Hugo + Hextra skeleton
* docs(site): move existing docs into Hugo content tree
* docs(site): fix links + H1s broken by docs-tree move
- Drop .md extensions on Hugo cross-doc links - Switch source-code references to absolute github.com/danmestas/libfossil URLs (relative ../ paths broke when files moved 3 dirs deeper) - Align H1 of architecture.md and migration-from-fossil.md with their frontmatter titles
* docs(site): add quickstart, examples, and SDK section stubs
* docs(site): tighten quickstart snippets + reference index
- Make the Sync example self-contained (open + sync, full main, real signatures) - Bridge from Clone to Open with a one-line prose link - Add a sentence to reference/_index.md so it does not render blank - Use the project's canonical "pure-Go, CGo-free" phrasing
* docs(site): add docs-gen-sdk Makefile target + commit generated SDK pages
* docs(site): pin gomarkdoc version + replace empty driver stubs with prose
- Add GOMARKDOC_VERSION Makefile variable so contributors don't drift on output format when a new gomarkdoc ships - Drop the two driver packages (modernc, ncruces) from gomarkdoc and hand-write _index.md pages explaining the register-on-import contract; the stubs were byte-stable but rendered as visibly broken documentation
* docs(site): add gen-llms-txt.sh + docs-gen-llms target
* docs(site): switch llms-full frontmatter strip from sed to awk
The sed range-negation pattern '/^---$/,/^---$/!p' silently re-opens a suppression range on any bare '---' in body content, eating Markdown horizontal rules and embedded YAML in fenced code blocks. The awk pattern strips the frontmatter only when it begins on line 1, leaving body content intact regardless of how many '---' lines it contains.
* hooks: pre-commit fails when SDK pages drift from code
* hooks: pre-commit re-installs gomarkdoc if it's the wrong version
The drift check's existing gate just looks for gomarkdoc on PATH. A contributor with an older gomarkdoc installed locally would have the gate pass and then run regeneration with their stale binary, producing either a silent false-negative or a confusing OUT-OF-DATE error with no version hint. Compare the installed version against GOMARKDOC_VERSION from Makefile and re-install on mismatch. Best-effort; offline contributors can still commit.
* docs(site): add docs-serve, docs-build, docs aggregate targets
* docs(site): make docs aggregate parallel-safe via explicit deps
The docs aggregate previously listed gen-sdk, gen-llms, and build as side-by-side prereqs. Make doesn't guarantee left-to-right ordering under -j, and gen-llms reads what gen-sdk writes, while build reads both. Encode the chain explicitly so 'make -j docs' is correct. Side benefit: 'make docs-build' standalone now produces a complete deployable site, matching contributor expectation.
* site(landing): fork dagnats home layout; rebrand chrome
* site(landing): rewrite §01–§07 content for libfossil
* site(landing): use .ascii class for diagram + fix §03 phrasing
* deploy: add wrangler.jsonc for CF Workers Static Assets
* docs: point README at the new docs site (user: [email protected], size: 45044) [annotate] [blame] [check-ins using]
cli
import "github.com/danmestas/libfossil/cli"
Index
- type Globals
- type RepoAddCmd
- type RepoAnnotateCmd
- type RepoBisectBadCmd
- type RepoBisectCmd
- type RepoBisectGoodCmd
- type RepoBisectLsCmd
- type RepoBisectNextCmd
- type RepoBisectResetCmd
- type RepoBisectSkipCmd
- type RepoBisectStatusCmd
- type RepoBlameCmd
- type RepoBranchCloseCmd
- type RepoBranchCmd
- type RepoBranchLsCmd
- type RepoBranchNewCmd
- type RepoCatCmd
- type RepoCiCmd
- type RepoCloneCmd
- type RepoCmd
- type RepoCoCmd
- type RepoConfigCmd
- type RepoConfigGetCmd
- type RepoConfigLsCmd
- type RepoConfigSetCmd
- type RepoConflictsCmd
- type RepoConflictsExtractCmd
- type RepoConflictsLsCmd
- type RepoConflictsMergeCmd
- type RepoConflictsPickCmd
- type RepoConflictsShowCmd
- type RepoDeltaApplyCmd
- type RepoDeltaCmd
- type RepoDeltaCreateCmd
- type RepoDiffCmd
- type RepoExtractCmd
- type RepoHashCmd
- type RepoInfoCmd
- type RepoInviteCmd
- type RepoLsCmd
- type RepoMergeCmd
- type RepoMergeResolveCmd
- type RepoNewCmd
- type RepoOpenCmd
- type RepoQueryCmd
- type RepoRedoCmd
- type RepoRenameCmd
- type RepoResolveCmd
- type RepoRevertCmd
- type RepoRmCmd
- type RepoSchemaAddCmd
- type RepoSchemaCmd
- type RepoSchemaListCmd
- type RepoSchemaRemoveCmd
- type RepoSchemaShowCmd
- type RepoStashApplyCmd
- type RepoStashClearCmd
- type RepoStashCmd
- type RepoStashDropCmd
- type RepoStashLsCmd
- type RepoStashPopCmd
- type RepoStashSaveCmd
- type RepoStatusCmd
- type RepoTagAddCmd
- type RepoTagCmd
- type RepoTagLsCmd
- type RepoTimelineCmd
- type RepoUVCmd
- type RepoUVDeleteCmd
- type RepoUVGetCmd
- type RepoUVLsCmd
- type RepoUVPutCmd
- type RepoUndoCmd
- type RepoUserCmd
- type RepoVerifyCmd
- type RepoWikiCmd
- type RepoWikiExportCmd
- type RepoWikiLsCmd
- type UserAddCmd
- type UserListCmd
- type UserPasswdCmd
- type UserRmCmd
- type UserUpdateCmd
type Globals
Globals holds flags shared by all CLI commands.
type Globals struct {
Repo string `short:"R" help:"Path to repository file" type:"path"`
Verbose bool `short:"v" help:"Verbose output"`
}
func (*Globals) OpenRepo
func (g *Globals) OpenRepo() (*libfossil.Repo, error)
OpenRepo opens a Fossil repository using the handle API. If Repo is empty, it searches for a .fossil file or .fslckout checkout.
type RepoAddCmd
RepoAddCmd stages files for addition in the checkout database.
type RepoAddCmd struct {
Files []string `arg:"" required:"" help:"Files to stage for addition"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoAddCmd) Run
func (c *RepoAddCmd) Run(g *Globals) error
type RepoAnnotateCmd
RepoAnnotateCmd annotates file lines with version history.
type RepoAnnotateCmd struct {
File string `arg:"" required:"" help:"File to annotate"`
Version string `help:"Starting version (default: tip)"`
}
func (*RepoAnnotateCmd) Run
func (c *RepoAnnotateCmd) Run(g *Globals) error
type RepoBisectBadCmd
RepoBisectBadCmd marks a version as bad.
type RepoBisectBadCmd struct {
Version string `arg:"" optional:"" help:"Version to mark (default: current checkout)"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoBisectBadCmd) Run
func (c *RepoBisectBadCmd) Run(g *Globals) error
type RepoBisectCmd
RepoBisectCmd groups binary search operations.
type RepoBisectCmd struct {
Good RepoBisectGoodCmd `cmd:"" help:"Mark version as good"`
Bad RepoBisectBadCmd `cmd:"" help:"Mark version as bad"`
Next RepoBisectNextCmd `cmd:"" help:"Check out midpoint version"`
Skip RepoBisectSkipCmd `cmd:"" help:"Skip current version"`
Reset RepoBisectResetCmd `cmd:"" help:"Clear bisect state"`
Ls RepoBisectLsCmd `cmd:"" help:"Show bisect path"`
Status RepoBisectStatusCmd `cmd:"" help:"Show bisect state"`
}
type RepoBisectGoodCmd
RepoBisectGoodCmd marks a version as good.
type RepoBisectGoodCmd struct {
Version string `arg:"" optional:"" help:"Version to mark (default: current checkout)"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoBisectGoodCmd) Run
func (c *RepoBisectGoodCmd) Run(g *Globals) error
type RepoBisectLsCmd
RepoBisectLsCmd shows the bisect path.
type RepoBisectLsCmd struct {
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoBisectLsCmd) Run
func (c *RepoBisectLsCmd) Run(g *Globals) error
type RepoBisectNextCmd
RepoBisectNextCmd checks out the bisect midpoint version.
type RepoBisectNextCmd struct {
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoBisectNextCmd) Run
func (c *RepoBisectNextCmd) Run(g *Globals) error
type RepoBisectResetCmd
RepoBisectResetCmd clears bisect state.
type RepoBisectResetCmd struct {
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoBisectResetCmd) Run
func (c *RepoBisectResetCmd) Run(g *Globals) error
type RepoBisectSkipCmd
RepoBisectSkipCmd skips the current version.
type RepoBisectSkipCmd struct {
Version string `arg:"" optional:"" help:"Version to skip (default: current checkout)"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoBisectSkipCmd) Run
func (c *RepoBisectSkipCmd) Run(g *Globals) error
type RepoBisectStatusCmd
RepoBisectStatusCmd shows bisect state.
type RepoBisectStatusCmd struct {
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoBisectStatusCmd) Run
func (c *RepoBisectStatusCmd) Run(g *Globals) error
type RepoBlameCmd
RepoBlameCmd is an alias for annotate.
type RepoBlameCmd struct {
RepoAnnotateCmd
}
type RepoBranchCloseCmd
RepoBranchCloseCmd closes a branch.
type RepoBranchCloseCmd struct {
Name string `arg:"" help:"Branch name to close"`
User string `help:"User for control artifacts (default: OS username)"`
}
func (*RepoBranchCloseCmd) Run
func (c *RepoBranchCloseCmd) Run(g *Globals) error
type RepoBranchCmd
RepoBranchCmd groups branch operations.
type RepoBranchCmd struct {
Ls RepoBranchLsCmd `cmd:"" help:"List branches"`
New RepoBranchNewCmd `cmd:"" help:"Create new branch"`
Close RepoBranchCloseCmd `cmd:"" help:"Close a branch"`
}
type RepoBranchLsCmd
RepoBranchLsCmd lists branches.
type RepoBranchLsCmd struct {
Closed bool `help:"Show only closed branches"`
All bool `help:"Show all branches (open and closed)"`
}
func (*RepoBranchLsCmd) Run
func (c *RepoBranchLsCmd) Run(g *Globals) error
type RepoBranchNewCmd
RepoBranchNewCmd creates a new branch.
type RepoBranchNewCmd struct {
Name string `arg:"" help:"Branch name"`
From string `help:"Parent version (default: tip)"`
Message string `short:"m" help:"Checkin comment"`
User string `help:"Checkin user (default: OS username)"`
}
func (*RepoBranchNewCmd) Run
func (c *RepoBranchNewCmd) Run(g *Globals) error
type RepoCatCmd
RepoCatCmd outputs the content of an artifact.
type RepoCatCmd struct {
Artifact string `arg:"" help:"Artifact UUID or prefix"`
Raw bool `help:"Output raw blob (no delta expansion)"`
}
func (*RepoCatCmd) Run
func (c *RepoCatCmd) Run(g *Globals) error
type RepoCiCmd
RepoCiCmd creates a new checkin (commit).
type RepoCiCmd struct {
Message string `short:"m" required:"" help:"Checkin comment"`
Files []string `arg:"" required:"" help:"Files to checkin"`
User string `help:"Checkin user (default: OS username)"`
Parent string `help:"Parent version UUID (default: tip)"`
Branch string `help:"Branch name for this checkin"`
}
func (*RepoCiCmd) Run
func (c *RepoCiCmd) Run(g *Globals) error
type RepoCloneCmd
RepoCloneCmd clones a remote Fossil repository.
type RepoCloneCmd struct {
URL string `arg:"" optional:"" help:"Remote Fossil server URL"`
Path string `arg:"" optional:"" help:"Local path for new repository file"`
User string `short:"u" help:"Username for clone auth"`
Pass string `short:"p" help:"Password for clone auth"`
Invite string `help:"Invite token (from fossil invite)"`
}
func (*RepoCloneCmd) Run
func (c *RepoCloneCmd) Run(g *Globals) error
type RepoCmd
RepoCmd is the top-level command group for repository operations. Embed this in your CLI struct alongside Globals for a complete fossil CLI.
type RepoCmd struct {
New RepoNewCmd `cmd:"" help:"Create a new repository"`
Clone RepoCloneCmd `cmd:"" help:"Clone a remote repository"`
Ci RepoCiCmd `cmd:"" help:"Checkin file changes"`
Co RepoCoCmd `cmd:"" help:"Checkout a version"`
Ls RepoLsCmd `cmd:"" help:"List files in a version"`
Timeline RepoTimelineCmd `cmd:"" help:"Show repository history"`
Cat RepoCatCmd `cmd:"" help:"Output artifact content"`
Info RepoInfoCmd `cmd:"" help:"Repository statistics"`
Hash RepoHashCmd `cmd:"" help:"Hash files (SHA1 or SHA3)"`
Delta RepoDeltaCmd `cmd:"" help:"Delta create/apply operations"`
Config RepoConfigCmd `cmd:"" help:"Repository configuration"`
Query RepoQueryCmd `cmd:"" help:"Execute SQL against repository"`
Verify RepoVerifyCmd `cmd:"" help:"Verify repository integrity"`
Resolve RepoResolveCmd `cmd:"" help:"Resolve symbolic name to UUID"`
Extract RepoExtractCmd `cmd:"" help:"Extract files from a version"`
Wiki RepoWikiCmd `cmd:"" help:"Wiki page operations"`
Tag RepoTagCmd `cmd:"" help:"Tag operations"`
Open RepoOpenCmd `cmd:"" help:"Open a checkout in a directory"`
Status RepoStatusCmd `cmd:"" help:"Show working directory changes"`
Add RepoAddCmd `cmd:"" help:"Stage files for addition"`
Rm RepoRmCmd `cmd:"" help:"Stage files for removal"`
Rename RepoRenameCmd `cmd:"" help:"Rename a tracked file"`
Revert RepoRevertCmd `cmd:"" help:"Undo staging changes"`
Diff RepoDiffCmd `cmd:"" help:"Show changes vs a version"`
Merge RepoMergeCmd `cmd:"" help:"Merge a divergent version"`
Conflicts RepoConflictsCmd `cmd:"" help:"List/manage unresolved conflicts"`
MarkResolved RepoMergeResolveCmd `cmd:"" name:"mark-resolved" help:"Mark a conflict as resolved"`
Undo RepoUndoCmd `cmd:"" help:"Undo last operation"`
Redo RepoRedoCmd `cmd:"" help:"Redo undone operation"`
Stash RepoStashCmd `cmd:"" help:"Stash working changes"`
Bisect RepoBisectCmd `cmd:"" help:"Binary search for bugs"`
Annotate RepoAnnotateCmd `cmd:"" help:"Annotate file lines with version history"`
Blame RepoBlameCmd `cmd:"" help:"Alias for annotate"`
Branch RepoBranchCmd `cmd:"" help:"Branch operations"`
UV RepoUVCmd `cmd:"" name:"uv" help:"Unversioned file operations"`
Schema RepoSchemaCmd `cmd:"" help:"Synced table schema operations"`
User RepoUserCmd `cmd:"" help:"User management"`
Invite RepoInviteCmd `cmd:"" help:"Generate invite token for a user"`
}
type RepoCoCmd
RepoCoCmd checks out a version to the working directory.
type RepoCoCmd struct {
Version string `arg:"" optional:"" help:"Version to checkout (default: tip)"`
Dir string `short:"d" help:"Output directory (default: current dir)" default:"."`
Force bool `help:"Overwrite existing files"`
}
func (*RepoCoCmd) Run
func (c *RepoCoCmd) Run(g *Globals) error
type RepoConfigCmd
RepoConfigCmd groups configuration operations.
type RepoConfigCmd struct {
Ls RepoConfigLsCmd `cmd:"" help:"List all config entries"`
Get RepoConfigGetCmd `cmd:"" help:"Get a config value"`
Set RepoConfigSetCmd `cmd:"" help:"Set a config value"`
}
type RepoConfigGetCmd
RepoConfigGetCmd gets a single config value.
type RepoConfigGetCmd struct {
Key string `arg:"" help:"Config key to get"`
}
func (*RepoConfigGetCmd) Run
func (c *RepoConfigGetCmd) Run(g *Globals) error
type RepoConfigLsCmd
RepoConfigLsCmd lists all config entries.
type RepoConfigLsCmd struct{}
func (*RepoConfigLsCmd) Run
func (c *RepoConfigLsCmd) Run(g *Globals) error
type RepoConfigSetCmd
RepoConfigSetCmd sets a config value.
type RepoConfigSetCmd struct {
Key string `arg:"" help:"Config key"`
Value string `arg:"" help:"Config value"`
}
func (*RepoConfigSetCmd) Run
func (c *RepoConfigSetCmd) Run(g *Globals) error
type RepoConflictsCmd
RepoConflictsCmd groups conflict management operations.
type RepoConflictsCmd struct {
Ls RepoConflictsLsCmd `cmd:"" default:"1" help:"List all conflicts"`
Show RepoConflictsShowCmd `cmd:"" help:"Show all versions of a conflicted file"`
Pick RepoConflictsPickCmd `cmd:"" help:"Resolve by picking one version"`
Merge RepoConflictsMergeCmd `cmd:"" help:"Resolve by re-merging with a different strategy"`
Extract RepoConflictsExtractCmd `cmd:"" help:"Extract all versions to disk for manual editing"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
type RepoConflictsExtractCmd
RepoConflictsExtractCmd extracts all versions to disk for manual editing.
type RepoConflictsExtractCmd struct {
File string `arg:"" help:"Conflicted file to extract"`
Dir string `short:"d" help:"Output directory" default:"."`
}
func (*RepoConflictsExtractCmd) Run
func (c *RepoConflictsExtractCmd) Run(g *Globals) error
type RepoConflictsLsCmd
RepoConflictsLsCmd lists all conflicts.
type RepoConflictsLsCmd struct{}
func (*RepoConflictsLsCmd) Run
func (c *RepoConflictsLsCmd) Run(g *Globals) error
type RepoConflictsMergeCmd
RepoConflictsMergeCmd resolves a conflict by re-merging with a specified strategy.
type RepoConflictsMergeCmd struct {
File string `arg:"" help:"Conflicted file to re-merge"`
Strategy string `help:"Strategy to use" default:"three-way"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoConflictsMergeCmd) Run
func (c *RepoConflictsMergeCmd) Run(g *Globals) error
type RepoConflictsPickCmd
RepoConflictsPickCmd resolves a conflict by picking one version.
type RepoConflictsPickCmd struct {
File string `arg:"" help:"Conflicted file to resolve"`
Local bool `help:"Keep local version" xor:"version"`
Remote bool `help:"Keep remote version" xor:"version"`
Base bool `help:"Revert to base version" xor:"version"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoConflictsPickCmd) Run
func (c *RepoConflictsPickCmd) Run(g *Globals) error
type RepoConflictsShowCmd
RepoConflictsShowCmd shows all versions of a conflicted file.
type RepoConflictsShowCmd struct {
File string `arg:"" help:"Conflicted file to show"`
}
func (*RepoConflictsShowCmd) Run
func (c *RepoConflictsShowCmd) Run(g *Globals) error
type RepoDeltaApplyCmd
RepoDeltaApplyCmd applies a delta to a source file.
type RepoDeltaApplyCmd struct {
Source string `arg:"" help:"Source (original) file"`
Delta string `arg:"" help:"Delta file"`
Output string `short:"o" help:"Output file (default: stdout)"`
}
func (*RepoDeltaApplyCmd) Run
func (c *RepoDeltaApplyCmd) Run(g *Globals) error
type RepoDeltaCmd
RepoDeltaCmd groups delta create/apply operations.
type RepoDeltaCmd struct {
Create RepoDeltaCreateCmd `cmd:"" help:"Create a delta between two files"`
Apply RepoDeltaApplyCmd `cmd:"" help:"Apply a delta to a source file"`
}
type RepoDeltaCreateCmd
RepoDeltaCreateCmd creates a delta between two files.
type RepoDeltaCreateCmd struct {
Source string `arg:"" help:"Source (original) file"`
Target string `arg:"" help:"Target (new) file"`
Output string `short:"o" help:"Output file (default: stdout)"`
}
func (*RepoDeltaCreateCmd) Run
func (c *RepoDeltaCreateCmd) Run(g *Globals) error
type RepoDiffCmd
RepoDiffCmd shows changes in the working directory vs a repository version.
type RepoDiffCmd struct {
Version string `arg:"" optional:"" help:"Version to diff against (default: tip)"`
Dir string `short:"d" help:"Working directory to compare" default:"."`
Unified int `short:"U" help:"Lines of context" default:"3"`
}
func (*RepoDiffCmd) Run
func (c *RepoDiffCmd) Run(g *Globals) error
type RepoExtractCmd
RepoExtractCmd extracts files from a version.
type RepoExtractCmd struct {
Version string `help:"Version to extract from (default: tip)"`
Files []string `arg:"" optional:"" help:"Files to extract (default: all)"`
Dir string `short:"d" help:"Output directory" default:"."`
}
func (*RepoExtractCmd) Run
func (c *RepoExtractCmd) Run(g *Globals) error
type RepoHashCmd
RepoHashCmd hashes files using SHA1 or SHA3-256.
type RepoHashCmd struct {
Files []string `arg:"" required:"" help:"Files to hash"`
SHA3 bool `name:"sha3" help:"Use SHA3-256 instead of SHA1"`
}
func (*RepoHashCmd) Run
func (c *RepoHashCmd) Run(g *Globals) error
type RepoInfoCmd
RepoInfoCmd shows repository statistics.
type RepoInfoCmd struct{}
func (*RepoInfoCmd) Run
func (c *RepoInfoCmd) Run(g *Globals) error
type RepoInviteCmd
RepoInviteCmd generates an invite token for a new user.
type RepoInviteCmd struct {
Login string `arg:"" help:"Username for the invitee"`
Cap string `help:"Capability string (e.g. oi)" required:""`
URL string `help:"Sync URL to embed in token" default:""`
TTL time.Duration `help:"Token time-to-live (e.g. 24h)" default:"0"`
}
func (*RepoInviteCmd) Run
func (c *RepoInviteCmd) Run(g *Globals) error
type RepoLsCmd
RepoLsCmd lists files in a version.
type RepoLsCmd struct {
Version string `arg:"" optional:"" help:"Version to list (default: tip)"`
Long bool `short:"l" help:"Show sizes and hashes"`
}
func (*RepoLsCmd) Run
func (c *RepoLsCmd) Run(g *Globals) error
type RepoMergeCmd
RepoMergeCmd merges a divergent version into the current checkout.
type RepoMergeCmd struct {
Version string `arg:"" help:"Version to merge into current checkout"`
Strategy string `help:"Override merge strategy for all files"`
DryRun bool `help:"Show what would be merged without writing"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoMergeCmd) Run
func (c *RepoMergeCmd) Run(g *Globals) error
type RepoMergeResolveCmd
RepoMergeResolveCmd marks a file conflict as resolved.
type RepoMergeResolveCmd struct {
File string `arg:"" help:"File to mark as resolved"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoMergeResolveCmd) Run
func (c *RepoMergeResolveCmd) Run(g *Globals) error
type RepoNewCmd
RepoNewCmd creates a new Fossil repository.
type RepoNewCmd struct {
Path string `arg:"" help:"Path for new repository file"`
User string `help:"Default user name" default:""`
}
func (*RepoNewCmd) Run
func (c *RepoNewCmd) Run(g *Globals) error
type RepoOpenCmd
RepoOpenCmd opens a checkout in a directory, creating the .fslckout database.
type RepoOpenCmd struct {
Dir string `arg:"" optional:"" help:"Checkout directory (default: current dir)" default:"."`
}
func (*RepoOpenCmd) Run
func (c *RepoOpenCmd) Run(g *Globals) error
type RepoQueryCmd
RepoQueryCmd executes raw SQL against the repository database.
type RepoQueryCmd struct {
SQL string `arg:"" help:"SQL query to execute"`
}
func (*RepoQueryCmd) Run
func (c *RepoQueryCmd) Run(g *Globals) error
type RepoRedoCmd
RepoRedoCmd re-applies the last undone operation.
type RepoRedoCmd struct {
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoRedoCmd) Run
func (c *RepoRedoCmd) Run(g *Globals) error
type RepoRenameCmd
RepoRenameCmd renames a tracked file in the checkout.
type RepoRenameCmd struct {
From string `arg:"" help:"Current file name"`
To string `arg:"" help:"New file name"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoRenameCmd) Run
func (c *RepoRenameCmd) Run(g *Globals) error
type RepoResolveCmd
RepoResolveCmd resolves a symbolic name to UUID and RID.
type RepoResolveCmd struct {
Name string `arg:"" help:"Symbolic name, UUID, or prefix to resolve (e.g. trunk, tip, UUID prefix)"`
}
func (*RepoResolveCmd) Run
func (c *RepoResolveCmd) Run(g *Globals) error
type RepoRevertCmd
RepoRevertCmd undoes staging changes in the checkout.
type RepoRevertCmd struct {
Files []string `arg:"" optional:"" help:"Files to revert (default: all)"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoRevertCmd) Run
func (c *RepoRevertCmd) Run(g *Globals) error
type RepoRmCmd
RepoRmCmd stages files for removal from the checkout.
type RepoRmCmd struct {
Files []string `arg:"" required:"" help:"Files to stage for removal"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoRmCmd) Run
func (c *RepoRmCmd) Run(g *Globals) error
type RepoSchemaAddCmd
RepoSchemaAddCmd registers a new synced table.
type RepoSchemaAddCmd struct {
Name string `arg:"" help:"Table name (without x_ prefix)"`
Columns string `required:"" help:"Column defs: name:type[:pk],... (e.g. peer_id:text:pk,addr:text)"`
Conflict string `default:"mtime-wins" enum:"self-write,mtime-wins,owner-write" help:"Conflict strategy"`
}
func (*RepoSchemaAddCmd) Run
func (c *RepoSchemaAddCmd) Run(g *Globals) error
type RepoSchemaCmd
RepoSchemaCmd groups synced table schema operations.
type RepoSchemaCmd struct {
Add RepoSchemaAddCmd `cmd:"" help:"Register a new synced table"`
List RepoSchemaListCmd `cmd:"" help:"List registered synced tables"`
Show RepoSchemaShowCmd `cmd:"" help:"Show table schema details"`
Remove RepoSchemaRemoveCmd `cmd:"" help:"Remove a synced table registration"`
}
type RepoSchemaListCmd
RepoSchemaListCmd lists registered synced tables.
type RepoSchemaListCmd struct{}
func (*RepoSchemaListCmd) Run
func (c *RepoSchemaListCmd) Run(g *Globals) error
type RepoSchemaRemoveCmd
RepoSchemaRemoveCmd removes a synced table registration.
type RepoSchemaRemoveCmd struct {
Name string `arg:"" help:"Table name (without x_ prefix)"`
}
func (*RepoSchemaRemoveCmd) Run
func (c *RepoSchemaRemoveCmd) Run(g *Globals) error
type RepoSchemaShowCmd
RepoSchemaShowCmd shows table schema details.
type RepoSchemaShowCmd struct {
Name string `arg:"" help:"Table name (without x_ prefix)"`
}
func (*RepoSchemaShowCmd) Run
func (c *RepoSchemaShowCmd) Run(g *Globals) error
type RepoStashApplyCmd
RepoStashApplyCmd applies a stash entry without removing it.
type RepoStashApplyCmd struct {
ID int64 `arg:"" optional:"" help:"Stash ID to apply (default: latest)"`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoStashApplyCmd) Run
func (c *RepoStashApplyCmd) Run(g *Globals) error
type RepoStashClearCmd
RepoStashClearCmd removes all stash entries.
type RepoStashClearCmd struct{}
func (*RepoStashClearCmd) Run
func (c *RepoStashClearCmd) Run(g *Globals) error
type RepoStashCmd
RepoStashCmd groups stash operations.
type RepoStashCmd struct {
Save RepoStashSaveCmd `cmd:"" help:"Stash working changes"`
Pop RepoStashPopCmd `cmd:"" help:"Apply top stash and drop it"`
Apply RepoStashApplyCmd `cmd:"" help:"Apply stash without dropping"`
Ls RepoStashLsCmd `cmd:"" help:"List stash entries"`
Drop RepoStashDropCmd `cmd:"" help:"Remove stash entry"`
Clear RepoStashClearCmd `cmd:"" help:"Remove all stash entries"`
}
type RepoStashDropCmd
RepoStashDropCmd removes a stash entry by ID.
type RepoStashDropCmd struct {
ID int64 `arg:"" required:"" help:"Stash ID to drop"`
}
func (*RepoStashDropCmd) Run
func (c *RepoStashDropCmd) Run(g *Globals) error
type RepoStashLsCmd
RepoStashLsCmd lists stash entries.
type RepoStashLsCmd struct{}
func (*RepoStashLsCmd) Run
func (c *RepoStashLsCmd) Run(g *Globals) error
type RepoStashPopCmd
RepoStashPopCmd pops the top stash entry.
type RepoStashPopCmd struct {
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoStashPopCmd) Run
func (c *RepoStashPopCmd) Run(g *Globals) error
type RepoStashSaveCmd
RepoStashSaveCmd saves working changes to the stash.
type RepoStashSaveCmd struct {
Message string `short:"m" help:"Stash message" default:""`
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoStashSaveCmd) Run
func (c *RepoStashSaveCmd) Run(g *Globals) error
type RepoStatusCmd
RepoStatusCmd shows working directory changes vs the tip version.
type RepoStatusCmd struct {
Dir string `short:"d" help:"Checkout directory to scan" default:"."`
}
func (*RepoStatusCmd) Run
func (c *RepoStatusCmd) Run(g *Globals) error
type RepoTagAddCmd
RepoTagAddCmd adds a tag to an artifact.
type RepoTagAddCmd struct {
Tag string `arg:"" help:"Tag name"`
Value string `arg:"" optional:"" help:"Tag value (optional)"`
Version string `help:"Version to tag (default: tip)"`
}
func (*RepoTagAddCmd) Run
func (c *RepoTagAddCmd) Run(g *Globals) error
type RepoTagCmd
RepoTagCmd groups tag operations.
type RepoTagCmd struct {
Ls RepoTagLsCmd `cmd:"" help:"List tags on an artifact"`
Add RepoTagAddCmd `cmd:"" help:"Add a tag to an artifact"`
}
type RepoTagLsCmd
RepoTagLsCmd lists tags on an artifact.
type RepoTagLsCmd struct {
Version string `arg:"" optional:"" help:"Version to list tags for (default: tip)"`
}
func (*RepoTagLsCmd) Run
func (c *RepoTagLsCmd) Run(g *Globals) error
type RepoTimelineCmd
RepoTimelineCmd shows repository timeline/history.
type RepoTimelineCmd struct {
Limit int `short:"n" default:"20" help:"Number of entries"`
}
func (*RepoTimelineCmd) Run
func (c *RepoTimelineCmd) Run(g *Globals) error
type RepoUVCmd
RepoUVCmd groups unversioned file operations.
type RepoUVCmd struct {
Ls RepoUVLsCmd `cmd:"" help:"List unversioned files"`
Put RepoUVPutCmd `cmd:"" help:"Add or update an unversioned file"`
Get RepoUVGetCmd `cmd:"" help:"Retrieve an unversioned file"`
Delete RepoUVDeleteCmd `cmd:"" help:"Delete an unversioned file (creates tombstone)"`
}
type RepoUVDeleteCmd
RepoUVDeleteCmd deletes an unversioned file (creates a tombstone).
type RepoUVDeleteCmd struct {
Name string `arg:"" help:"Name of the unversioned file to delete"`
}
func (*RepoUVDeleteCmd) Run
func (c *RepoUVDeleteCmd) Run(g *Globals) error
type RepoUVGetCmd
RepoUVGetCmd retrieves an unversioned file.
type RepoUVGetCmd struct {
Name string `arg:"" help:"Name of the unversioned file"`
Output string `short:"o" help:"Output file (default: stdout)"`
}
func (*RepoUVGetCmd) Run
func (c *RepoUVGetCmd) Run(g *Globals) error
type RepoUVLsCmd
RepoUVLsCmd lists unversioned files.
type RepoUVLsCmd struct{}
func (*RepoUVLsCmd) Run
func (c *RepoUVLsCmd) Run(g *Globals) error
type RepoUVPutCmd
RepoUVPutCmd adds or updates an unversioned file.
type RepoUVPutCmd struct {
Name string `arg:"" help:"Name of the unversioned file"`
File string `arg:"" help:"Local file to upload"`
}
func (*RepoUVPutCmd) Run
func (c *RepoUVPutCmd) Run(g *Globals) error
type RepoUndoCmd
RepoUndoCmd undoes the last checkout operation.
type RepoUndoCmd struct {
Dir string `short:"d" help:"Checkout directory" default:"."`
}
func (*RepoUndoCmd) Run
func (c *RepoUndoCmd) Run(g *Globals) error
type RepoUserCmd
RepoUserCmd groups user management operations.
type RepoUserCmd struct {
Add UserAddCmd `cmd:"" help:"Create a new user"`
List UserListCmd `cmd:"" help:"List all users"`
Update UserUpdateCmd `cmd:"" help:"Update user capabilities"`
Rm UserRmCmd `cmd:"" help:"Delete a user"`
Passwd UserPasswdCmd `cmd:"" help:"Reset user password"`
}
type RepoVerifyCmd
RepoVerifyCmd verifies repository integrity.
type RepoVerifyCmd struct{}
func (*RepoVerifyCmd) Run
func (c *RepoVerifyCmd) Run(g *Globals) error
type RepoWikiCmd
RepoWikiCmd groups wiki operations.
type RepoWikiCmd struct {
Ls RepoWikiLsCmd `cmd:"" help:"List wiki pages"`
Export RepoWikiExportCmd `cmd:"" help:"Export a wiki page"`
}
type RepoWikiExportCmd
RepoWikiExportCmd exports a wiki page.
type RepoWikiExportCmd struct {
Page string `arg:"" help:"Wiki page name or artifact UUID"`
Output string `short:"o" help:"Output file (default: stdout)"`
}
func (*RepoWikiExportCmd) Run
func (c *RepoWikiExportCmd) Run(g *Globals) error
type RepoWikiLsCmd
RepoWikiLsCmd lists wiki pages.
type RepoWikiLsCmd struct{}
func (*RepoWikiLsCmd) Run
func (c *RepoWikiLsCmd) Run(g *Globals) error
type UserAddCmd
UserAddCmd creates a new user.
type UserAddCmd struct {
Login string `arg:"" help:"Username"`
Cap string `help:"Capability string (e.g. oi)" required:""`
}
func (*UserAddCmd) Run
func (c *UserAddCmd) Run(g *Globals) error
type UserListCmd
UserListCmd lists all users.
type UserListCmd struct{}
func (*UserListCmd) Run
func (c *UserListCmd) Run(g *Globals) error
type UserPasswdCmd
UserPasswdCmd resets a user's password.
type UserPasswdCmd struct {
Login string `arg:"" help:"Username"`
}
func (*UserPasswdCmd) Run
func (c *UserPasswdCmd) Run(g *Globals) error
type UserRmCmd
UserRmCmd deletes a user.
type UserRmCmd struct {
Login string `arg:"" help:"Username"`
}
func (*UserRmCmd) Run
func (c *UserRmCmd) Run(g *Globals) error
type UserUpdateCmd
UserUpdateCmd updates user capabilities.
type UserUpdateCmd struct {
Login string `arg:"" help:"Username"`
Cap string `help:"New capability string" required:""`
}
func (*UserUpdateCmd) Run
func (c *UserUpdateCmd) Run(g *Globals) error
Generated by gomarkdoc