hancock

Check-in [2d1f75bf65]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:documentation edits
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 2d1f75bf65de88a3eca459ee2027105c45c71edd1e5924f55c9c24f652f526bf
User & Date: dnc 2020-03-02 02:05:25
Context
2020-03-02
02:05
go module tidy Leaf check-in: 0c578e35f1 user: dnc tags: trunk
02:05
documentation edits check-in: 2d1f75bf65 user: dnc tags: trunk
02:05
cmd/hancock: documentation edits check-in: b5d9be6c75 user: dnc tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to README.md.

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
testimony from a distributed network of servers is under development.

The name "hancock" comes from "John Hancock" - a slang term in the United
States meaning a person's signature.

Copyright (C) 2019, 2020 David N. Cohen see source code for license (AGPL 3)

## Dependencies

For building hancock, install a (very) recent version of Go. See
https://golang.org/doc/install .

## Build and Configure

    go get src.d10.dev/hancock/cmd/...

## General Usage As Author

The hancock command expects optional flags and exactly one operation. Each
operation may expect operation-specific flags or arguments.

    hancock [command flags] operation [operation flags] [operation args]

Each operation produces output to stdout and expects input from stdin, in
order to create a pipeline. For example:

    hancock manifest /my/source/file | hancock-sign | hancock testimony

This pipeline construction is intended to isolate signing code from the code
which produces and publishes data. Isolation, in this case, minimizes the
amount of code which handles secrets, and allows signing to be performed on
an isolated machine.

## Operation manifest

Construct a manifest representing a source file with:

    hancock manifest /path/to/source/file [...]








|
<
<
<
<
<



|











|
|
|
|







16
17
18
19
20
21
22
23





24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
testimony from a distributed network of servers is under development.

The name "hancock" comes from "John Hancock" - a slang term in the United
States meaning a person's signature.

Copyright (C) 2019, 2020 David N. Cohen see source code for license (AGPL 3)

Build/Install






    go get src.d10.dev/hancock/cmd/...

## General Usage As Author of Source Code

The hancock command expects optional flags and exactly one operation. Each
operation may expect operation-specific flags or arguments.

    hancock [command flags] operation [operation flags] [operation args]

Each operation produces output to stdout and expects input from stdin, in
order to create a pipeline. For example:

    hancock manifest /my/source/file | hancock-sign | hancock testimony

This pipeline construction is allows the signing tool be run in a secure
environment, isolated from the tool which publishes data. Isolation, in this
case, minimizes the amount of code which handles secrets, and allows signing
to be performed on an seperate machine.

## Operation manifest

Construct a manifest representing a source file with:

    hancock manifest /path/to/source/file [...]

Changes to doc.go.

1

2
3
4
// See cmd/hancock for details.

package hancock

//go:generate sh -c "go doc ./cmd/hancock | dumbdown > README.md"

>



1
2
3
4
5
// See cmd/hancock for details.

package hancock

//go:generate sh -c "go doc ./cmd/hancock | dumbdown > README.md"