got

package module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 20, 2021 License: GPL-3.0 Imports: 4 Imported by: 0

README

Got

Like Git, but with an 'o'

Got is version control, with a model similar to Git's, extending ideas from WebFS.

Got uses INET256 to easily and securely connect repositories.

CLI Docs

ARCHITECTURE.md

Features/Roadmap

  • E2E encryption. Branch names, directory names, file names, and file sizes can all be hidden from remote repositories.
  • Stage changes with add, rm, put, and discard commands.
  • Inspect branch state with cat and ls.
  • Print and change the active branch with active command.
  • Commit changes, with commit.
  • Create, delete, and list branches with branch commands.
  • Copy one branch state to another with sync.
  • Share repositories over INET256 using serve command.
  • Branch level access control using ACL defined in a .got/policy file.
  • Checkout the head of a branch to the working directory.
  • Merge 2 branches.

Getting Started

Either download a prebuilt binary or build one from source.

Then initialize a repository in the current working directory. Make sure you cd to where you want the repository.

$ got init

Contributing

To run the tests:

$ make test

Installs to $GOPATH/bin with make. If that isn't on your path, just copy the executable from there to wherever you want.

$ make install

To build release binaries

TAG=v0.0.x make build

Where TAG is an environment variable which should be set to the release version, or the Git hash of the source used for the build. The release binaries will be under the build directory.

More

Read more about the configuration objects in docs/config.md.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConfigureRepo

func ConfigureRepo(p string, fn func(RepoConfig) RepoConfig) error

func InitRepo

func InitRepo(p string) error

Types

type Ref

type Ref = gdat.Ref

type Repo

type Repo = gotrepo.Repo

func OpenRepo

func OpenRepo(p string) (*Repo, error)

type RepoConfig

type RepoConfig = gotrepo.Config

type Root

type Root = gotfs.Root

type Snap

type Snap = gotvc.Snap

type SnapInfo

type SnapInfo = gotvc.SnapInfo

Directories

Path Synopsis
cmd
got command
pkg
porting
package porting deals with importing and exporting to and from gotfs
package porting deals with importing and exporting to and from gotfs

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL