Artifact [696695c249]

Artifact 696695c2498eb47411ca965f93545f003dba01fd572e0f2bee2a5e3811693ffd:

• File docs/site/content/docs/quickstart.md — part of check-in [6273a0750d] at 2026-07-22 23:03:24 on branch trunk — fix: correct go.mod module path to go-libfossil (#76) (#117)

  * fix: correct go.mod module path to go-libfossil (#76)

  The module directive still declared github.com/danmestas/libfossil after the repository was renamed to go-libfossil. pkg.go.dev/godoc scraping matches the declared module path against its hosting path, so the stale path broke SDK doc generation.

  Rename the module path across all four in-repo modules (root, the two db/driver submodules, observer/otel, and docs/site) and every internal import, plus the release workflow, the doc-generation script, and the docs.

  No tag has been published under the go-libfossil path yet, so the cross-module requires cannot resolve from the proxy. Add replace directives pointing the in-repo requires at their local directories so GOWORK=off builds and the CI matrix resolve without a published version. These replaces are ignored by downstream consumers and can be dropped once new-path tags are cut.

  * Guard releases against replace directives; regenerate SDK docs

  The go-libfossil rename bridges the in-repo modules with `replace` directives. Go refuses a main module that carries them, so a tag cut while they are present breaks `go install .../cmd/libfossil@<tag>` and every `@version` fetch of the driver submodules. Add a Release workflow step that fails the job before anything is published if any tracked go.mod still contains a replace directive, so the bridge is a CI-enforced TODO rather than a silent landmine. The step comment records what unblocks a release: re-tag the submodules with the corrected module paths, bump the root requires, then drop the replace blocks.

  Regenerate the SDK reference docs. The previous pass only substituted URLs over the pre-existing generated files, leaving stale signatures (Repo.Timeline was still documented as taking LogOpts rather than TimelineOpts). Note that gomarkdoc must be run outside a git worktree — inside one it silently strips every source link.

  Also reword the README rename note, which read as though the import path had not changed, and re-sort the ncruces require block. (user: [email protected], size: 2271) [annotate] [blame] [check-ins using]

---
title: Quickstart
weight: 10
---

A five-minute tour of libfossil: clone a repo and read its history from Go.

## Install

```sh
go install github.com/danmestas/go-libfossil/cmd/libfossil@latest
libfossil --help
```

The binary is pure-Go and CGo-free — drop it on any host.

## Clone a repository

Clone using the Go API:

```go
package main

import (
    "context"
    "log"

    "github.com/danmestas/go-libfossil"
)

func main() {
    t := libfossil.NewHTTPTransport("https://example.com/repo.fossil")
    repo, _, err := libfossil.Clone(context.Background(), "./repo.fossil", t, libfossil.CloneOpts{})
    if err != nil {
        log.Fatal(err)
    }
    defer repo.Close()
}
```

## Open from Go

After cloning (above), open the same `.fossil` file from Go and read its history:

```go
package main

import (
    "fmt"
    "log"

    "github.com/danmestas/go-libfossil"
)

func main() {
    repo, err := libfossil.Open("repo.fossil")
    if err != nil {
        log.Fatal(err)
    }
    defer repo.Close()

    entries, err := repo.Timeline(libfossil.TimelineOpts{Limit: 10})
    if err != nil {
        log.Fatal(err)
    }
    for _, e := range entries {
        fmt.Println(e.UUID, e.Comment)
    }
}
```

## Sync over HTTP

```go
package main

import (
    "context"
    "log"

    "github.com/danmestas/go-libfossil"
)

func main() {
    repo, err := libfossil.Open("repo.fossil")
    if err != nil {
        log.Fatal(err)
    }
    defer repo.Close()

    t := libfossil.NewHTTPTransport("https://example.com/repo.fossil")
    if _, err := repo.Sync(context.Background(), t, libfossil.SyncOpts{Pull: true}); err != nil {
        log.Fatal(err)
    }
}
```

Or use the simpler `Pull` wrapper for pull-only workflows:

```go
_, err := repo.Pull(context.Background(), "https://example.com/repo.fossil", libfossil.PullOpts{})
```

## Next steps

- [Architecture](../architecture) — how the pieces fit
- [Production patterns](../production) — error handling, context, telemetry beyond `log.Fatal`
- [Extension Points](../extension-points) — observers for telemetry, custom SQLite drivers
- [Migration from Fossil](../migration-from-fossil) — command mapping from upstream
- [SDK reference](../reference/sdk) — every package, every exported symbol