Documentation
¶
Index ¶
Constants ¶
View Source
const ( // Success is the same as EXIT_SUCCESS in C Success = iota // BadArgs passed to cli; not our fault. BadArgs // BadPassword passed to prompt or switch; not our fault. BadPassword // DaemonNotResponding means the daemon does not respond in timely fashion. // Probably our fault. DaemonNotResponding // UnknownError is an uncategorized error, probably our fault. UnknownError )
Variables ¶
View Source
var ExplicitPinFlags = []cli.Flag{ cli.StringFlag{ Name: "from,f", Value: "HEAD", Usage: "Specify the commit to start from", }, cli.StringFlag{ Name: "to,t", Value: "INIT", Usage: "Specify the maximum commit to iterate to", }, }
View Source
var HelpTexts = map[string]Help{ "init": { Usage: "Initialize a new repository", ArgsUsage: "<username>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.StringFlag{ Name: "backend,b", Value: "ipfs", Usage: "What data backend to use for the new repo", }, cli.StringFlag{ Name: "p,path", Value: "", Usage: "Where to create the new repository (overwrites BRIG_PATH)", }, }, Description: `Initialize a new repository with a certain backend. If BRIG_PATH is set, the new repository will be created at this place. If not, the current working directory is used. If the directory is not empty, brig will warn you about it and abort. The username can be specified as pretty much any string, but it is recommended to use the special format »user@domain.something/resource«. This is similar to XMPP IDs. Specifying a resource can help you use the same name for different computers and specifying a domain makes it possible to indicate groups. This is especially important for commands like »brig net locate«. `, }, "whoami": { Usage: "Print the own remote identity", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "fingerprint,f", Usage: "Only print the own fingerprint", }, cli.BoolFlag{ Name: "name,n", Usage: "Only print the own name", }, }, Description: `This command prints your name, fingerprint and what store you are looking at. When you initialized your repository, you chose the name and a fingerprint (a long hash value) was created for you. The store you're looking at, is by default your own. Every user has it's own store. See also the documentation for the »become« command. `, }, "remote": { Usage: "Manage remotes (other authenticated users)", Complete: completeSubcommands, Description: `Add, list, edit and remove remotes. You need to add a remote for every peer or place you want to sync with. In order to add a remote, you need their fingerprint, which should be exchange in prior. You can view your own fingerprint with the »whoami« command. Also see the »net locate« command for more information. `, }, "remote.add": { Usage: "Add a new remote", ArgsUsage: "<name> <fingerprint>", Complete: completeArgsUsage, Description: "Add a new remote under a handy name with their fingerprint.", }, "remote.remove": { Usage: "Remove a remote by name", ArgsUsage: "<name>", Complete: completeArgsUsage, Description: "Remove a remote by name", }, "remote.list": { Usage: "List all remotes and their online status", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "offline,o", Usage: "Do not query the online status", }, }, Description: `This goes over every entry in your remote list and prins his name, network address, rountrip and when we was last seen this remote.`, }, "remote.clear": { Usage: "Clear the complete remote list", Complete: completeArgsUsage, Description: "Clear the complete remote list. Note that you cannot undo this operation.", }, "remote.edit": { Usage: "Edit the current list", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.StringFlag{ Name: "yml,y", Value: "", Usage: "Directly overwrite remote list with yml file", }, }, Description: `Edit the current list using $EDITOR as YAML file. It will be updated upon saving`, }, "remote.ping": { Usage: "Ping a remote", Complete: completeArgsUsage, Description: `Ping a remote and check if we can reach them. There is a small difference to the »remote list« command. »ping« will only work if both sides authenticated each other and can thus be used as a test for this. Additonally, it shows the roundtrip time, the ping request took to travel. `, }, "pin": { Usage: "Commands to pin a certain file", ArgsUsage: "<file>", Complete: completeSubcommands, Description: `Pinning a file to keep it in local storage. When you retrieve a file from a remote machine, the file will be cached (maybe partially) for some time on your machine. After some time, or after hitting a certain space limit, the file will be cleaned up to reclaim space. By adding a pin, you can make sure that this file will not be deleted. Pinning can be useful for keeping old versions or to download files for offline use. Note however that pinning a file does not cause it to be automatically downloaded. Until we have a proper way to do this, you can use »brig cat <file> > /dev/null«. This command contains the subcommand 'add', but for usability reasons, »brig pin add <path>« is the same as »brig pin <path>«. See also the »gc« command as counterpart of pinning. `, }, "pin.add": { Usage: "Pin a file or directory to local storage", ArgsUsage: "<file>", Complete: completeArgsUsage, Description: `A node that is pinned to local storage will not be deleted by the garbage collector.`, }, "pin.list": { Usage: "List all explicitly pinned files in a certain commit range", Complete: completeArgsUsage, Description: `List all explicitly pinned files in a certain commit range. This only shows the files (along with the latest commit it appears in) that were explicitly pinned by the user. Files that were pinned by brig itself (i.e. implictly when receiving it from somebody else) are not sown by this command. You can specify a certain PREFIX to list only the files in a certain directory. If no PREFIX is given, all paths are shown. `, ArgsUsage: "[<PREFIX>]", Flags: ExplicitPinFlags, }, "pin.clear": { Usage: "A more powerful version of `brig pin rm`", ArgsUsage: "[<PREFIX>]", Complete: completeArgsUsage, Description: `Clear all explicit pins in a certain commit range where path starts with PREFIX. This command is useful to get rid of old pins that you likely do not need anymore. Also it's useful to unpin everything and pin only certain parts with running »brig gc« afterwards. You should be however careful not to unpin CURR or HEAD, since this might lead to dataloss if »brig gc« at some point. `, Flags: ExplicitPinFlags, }, "pin.set": { Usage: "A more powerful version of `brig pin set`", ArgsUsage: "[<PREFIX>]", Complete: completeArgsUsage, Description: `Explicitly pin all files in the range between --from and --to that start with PREFIX.`, Flags: ExplicitPinFlags, }, "pin.remove": { Usage: "Remove a pin", ArgsUsage: "<file>", Complete: completeArgsUsage, Description: `A node that is pinned to local storage will not be deleted by the garbage collector.`, }, "net": { Usage: "Commands to go online/offline, list other users and locate them", Complete: completeSubcommands, Description: `This command offers various subcommands that allow to change and check your online status (»online/offline/status«), and to see what other remotes are online. Most importantly, you can search other users by their name of by parts of it.`, }, "net.offline": { Usage: "Disconnect from the global network", Complete: completeArgsUsage, Description: `After going offline, other peers will not be able to contact you any more and vice versa. The daemon keeps running in this time and you can do all offline operations.`, }, "net.online": { Usage: "Connect to the global network", Complete: completeArgsUsage, Description: `This is the opposite of going offline. It might take a few minutes until you are fully connected. You are online by default.`, }, "net.status": { Usage: "Check if you're connected to the global network", Complete: completeArgsUsage, Description: `This will either print the string »online« or »offline«`, }, "net.locate": { Usage: "Try to locate a remote by their name or by a part of it", ArgsUsage: "<name-or-part-of-it>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.StringFlag{ Name: "t,timeout", Value: "10s", Usage: "Wait at most <n> seconds before bailing out", }, cli.StringFlag{ Name: "m,mask", Value: "exact,domain,user,email", Usage: "Indicate what part of the id you want to query for", }, }, Description: `brig is able to find the fingerprint of other users (that are online) by a part of their name. See the help of »brig init« to see out of what components the name is built of. Each found item shows the name, the fingerprint and what part of their name matched with your query. Sometimes other peers are offline and cannot send your their fingerprint. In this case the peer will still be shown, but as »offline«. IMPORTANT: Locating a remote DOES NOT replace proper authentication. It is relatively easy to fake a fingerprint or even to have two peers with the same name. Always authenticate your peer properly via a sidechannel (mail, telephone, in person). »locate« is supposed to be only a help of discovering other nodes. Note that this operation might take quite a few seconds. Specifying »--timeout« can help, but currently it still might take longer than the given timeout.`, }, "status": { Usage: "Show what has changed in the current commit", Flags: []cli.Flag{ cli.BoolFlag{ Name: "tree,t", Usage: "View the status as a tree listing", }, }, Description: `This a shortcut for »brig diff HEAD CURR«. See the »diff« command for more information.`, }, "diff": { Usage: "Show what changed between two commits", ArgsUsage: "[<REMOTE>] [<OTHER_REMOTE> [<REMOTE_REV> [<OTHER_REMOTE_REV>]]]]", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "list,l", Usage: "Output the diff as simple list (like status)", }, cli.BoolFlag{ Name: "offline,o", Usage: "Do no fetch before computing the diff", }, }, Description: `View what sync would do when being called on the specified points in history. Diff does not show what changed inside of the files, but shows how the files themselves changed. To describe this, brig knows seven different change types: - Added (+): The file was added on the remote side. - Removed (-): The file was removed on the remote side. - Missing (_): The file is missing on the remote side (e.g. we added it) - Moved (→): The file was moved to a new location. - Ignored (*): This file was ignored because we chose to due to our settings. - Mergeable (⇄): Both sides have changes, but they can be merged. - Conflict (⚡): Both sides have changes but they conflict. Before computing the diff, it will try to fetch the metadata from the peer, if necessary. If you do not want this behaviour, use the »--offline« flag. See »brig commit« for a general explanation of commits. EXAMPLES: $ brig diff # Show diff from our CURR to our HEAD $ brig diff alice # Show diff from our CURR to alice's last state $ brig diff alice some_tag # Show diff from our CURR to 'some_tag' of alice $ brig diff alice bob HEAD HEAD # Show diff between alice and bob's HEAD $ brig diff alice alice HEAD CURR # Show diff between alice and bob's HEAD `, }, "tag": { Usage: "Tag a commit with a specific name", Complete: completeArgsUsage, ArgsUsage: "<commit> <name>", Flags: []cli.Flag{ cli.BoolFlag{ Name: "delete,d", Usage: "Delete the tag instead of creating it", }, }, Description: `Give a name to a commit, which is easier to remember than the hash. You can use the name you gave in all places where brig requires you to specify a commit. There are three special tags pre-defined for you: - CURR: A reference to the staging commit. - HEAD: The last fully completed commit. - INIT: The very first commit in the chain. Tags are case insensitive. That means that »HEAD« and »head« mean the same. EXAMPLES: $ brig tag SEfXUAH6AR my-tag-name # Name the commit SEfXUAH6AR 'my-tag-name'. $ brig tag -d my-tag-name # Delete the tag name again. `, }, "log": { Usage: "Show all commits in a certain range", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.StringFlag{ Name: "from,f", Value: "", Usage: "Lower range limit; initial commit if omitted", }, cli.StringFlag{ Name: "to,t", Value: "", Usage: "Upper range limit; HEAD if omitted", }, }, Description: `Show a list of commits from a start (--from) up to and end (--to). If omitted »--from INIT --to HEAD« will be assumed. The output will show one commit per line, each including the (short) hash of the commit, the date it was committed and the (optional) commit message. `, }, "fetch": { Usage: "Fetch all metadata from another peer", ArgsUsage: "<remote>", Complete: completeArgsUsage, Description: `Get all the latest metadata of a certain peer. This does not download any actual data, but only the metadata of it. You have to be authenticated to the user to get his data. Fetch will be done automatically by »sync« and »diff« and is usually only helpful when doing it together with »become«.`, }, "sync": { Usage: "Sync with another peer", ArgsUsage: "<remote>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "no-fetch,n", Usage: "Do not do a fetch before syncing", }, }, Description: `Sync and merge all metadata of another peer with our metadata. After this operation you might see new files in your folder. Those files were not downloaded yet and will be only on the first access. It is recommended that your first check what will be synced with »brig diff«. TODO: write some more documentation on this. `, }, "commit": { Usage: "Create a new commit", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.StringFlag{ Name: "message,m", Value: "", Usage: "Provide a meaningful commit message", }, }, Description: `Create a new commit. The message (»--message«) is optional. If you do not pass it, a message will be generated with contains the current time. The commit history can be viewed by »brig log«. Think of commits as snapshots that can be created explicitly by you or even automated in an interval. It is important to remember that »commit« will only create a snapshot of the metadata. It is not guaranteed that you can still access the actual data. In the current implementation all old file states are unpinned during a commit. That means that you can only access old data until the garbage collector ran (see »brig gc«) or if you pin the old file explicitly. `, }, "reset": { Usage: "Reset a file or the whole commit to an old state", ArgsUsage: "<commit> [<file>]", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "force,f", Usage: "Reset even when there are changes in the staging area", }, }, Description: `Reset a file to an old state by specifying the commit it should be reverted to. If you do not pass »<file>« the whole commit will be filled with the contents of the old commit. If you reset to an old commit and you have uncommitted changes, brig will warn you about that and refuse the »reset« unless you pass »--force«. Note for git users: It is not possible to go back in history and branch out from there. »reset« simply overwrites the staging commit (CURR) with an old state, thus keeping all the previous history. If you notice that you do not like the state you've resetted to, »brig reset head« will bring you back to the last known good state. `, }, "become": { Usage: "View the data of another user", ArgsUsage: "<remote>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "self,s", Usage: "Become self (i.e. the owner of the repository)", }, }, Description: `View the data of another user. You can temporarily explore the metadata of another user, by »becoming« them. Once you became a certain user (which needs to be in your remote list and on which you called »brig fetch« before), you can look around in the data like in yours. You can also modify files, but keep in mind that they will be reset on he next fetch. This is a rather esoteric command and it's likely that you won't use it often. It's currently mainly useful for debugging, but could be used with »fetch« to do some editing before the actual »sync«. `, }, "history": { Usage: "Show the history of a file or directory", ArgsUsage: "<path>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "empty,e", Usage: "Also show commits where nothing happens", }, }, Description: `Show a list of all changes that were made to this path. Not every change you ever made is recorded, but the change between each commit. Every line shows the type of change and what commits were involved. If it's a move, it will also show from and to where the path was moved. Possible types of changes are: - added: The file was added in this commit. - moved: The file was modified in this commit. - removed: The file was removed in this commit. - modified: The file was modified in this commit. Furthermore, the following combination are possible: - moved & modified: The file was moved and modified. - add & modified: The file was removed before and now re-added with different content. - moved & removed: The file was moved to another location. `, }, "stage": { Usage: "Add a local file to the storage", ArgsUsage: "(<local-path> [<path>]|--stdin <path>)", Complete: completeLocalFile, Flags: []cli.Flag{ cli.BoolFlag{ Name: "stdin,i", Usage: "Read data from stdin", }, }, Description: `Read a local file (given by »local-path«) and try to read it. This is the conceptual equivalent of »git add«. The stream will be encrypted and possibly compressed before saving it to ipfs. If you omit »path«, the file will be added under the root directory, with the basename of »local-path«. You can change this by specifying where to save the local file by additionally passing »path«. Additonally you can read the file from standard input, if you pass »--stdin«. In this case you pass only one path: The path where the stream is stored. EXAMPLES: $ brig stage file.png # gets added as /file.png $ brig stage file.png /photos/me.png # gets added as /photos/me.png $ cat file.png | brig --stdin /file.png # gets added as /file.png`, }, "touch": { Usage: "Create an empty file under the specified path", ArgsUsage: "<path>", Complete: completeArgsUsage, Description: `Convinience command for adding empty files. If the file or directory already exists, the modification time is updated to the current timestamp (like the original touch(1) does). `, }, "cat": { Usage: "Output the content of a file to standard output", ArgsUsage: "<path>", Complete: completeArgsUsage, Description: `Decrypt and decompress the stream from ipfs and write it to standard output. Outputting a directory is currently not allowed (but might be in the future by outputting a .tar archive of the directory contents). `, }, "info": { Usage: "Show metadata of a file or directory", ArgsUsage: "<path>", Complete: completeArgsUsage, Description: `Show all metadata attributes known for a file or directory. Path: Absolute path of the file inside of the storage. User: User which modified the file last. Type: »file« or »directory«. Size: Exact content size in bytes. Hash: Hash of the node. Inode: Internal inode. Also shown as inode in FUSE. Pinned: »yes« if the file is pinned, »no« else. ModTime: Timestamp of last modification. Content: Content hash of the file in ipfs. `, }, "rm": { Usage: "Remove a file or directory", ArgsUsage: "<path>", Complete: completeArgsUsage, Description: `Remove a file or directory. In contrast to the rm(1) there is no --recursive switch. Directories are deleted recursively by default. Note that you can still access the history of a accessed file. `, }, "ls": { Usage: "List files and directories", ArgsUsage: "<path>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.IntFlag{ Name: "depth,d", Usage: "Max depth to traverse", Value: 1, }, cli.BoolFlag{ Name: "recursive,R", Usage: "Allow recursive traverse", }, }, Description: `List files an directories starting with »path«. If no »<path>« is given, the root directory is assumed. Every line of »ls« shows a human readable size of each entry, the last modified timestmap, the user that last modified the entry (if there's more than one) and if the entry if pinned. `, }, "tree": { Usage: "List files and directories in a tree", ArgsUsage: "<path>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.IntFlag{ Name: "depth, d", Usage: "Max depth to traverse", Value: -1, }, }, Description: `Show entries in a tree(1)-like fashion. This command is identical to »brig ls« otherwise. `, }, "mkdir": { Usage: "Create an empty directory", ArgsUsage: "<path>", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "parents, p", Usage: "Create parent directories as needed", }, }, Description: `Create an empty directory at the specified »path«. By default, parent directories are not created. You can use »--parents« to enable this behaviour. `, }, "mv": { Usage: "Move a file or directory from »src« to »dst«", ArgsUsage: "<src> <dst>", Complete: completeArgsUsage, Description: `Move a file or directory from »src« to »dst.« If »dst« already exists and is a file, it gets overwritten with »src«. If »dst« already exists and is a directory, »basename(src)« is created inside, (if the file inside does not exist yet) It's not allowed to move a directory into itself. This includes moving the root directory. `, }, "cp": { Usage: "Copy a file or directory from »src« to »dst«", ArgsUsage: "<src> <dst>", Complete: completeArgsUsage, Description: `Copy a file or directory from »src« to »dst«. The semantics are the same as for »brig mv«, except that »cp« does not remove »src«. `, }, "edit": { Usage: "Edit a file inplae with $EDITOR", ArgsUsage: "<path>", Complete: completeArgsUsage, Description: `Convinience command to read the file at »path« and display it in $EDITOR. Once $EDITOR quits, the file is saved back. If $EDITOR is not set, nano is assumed (I cried a little). If nano is not installed this command will fail and you neet to set $EDITOR> `, }, "daemon": { Usage: "Daemon management commands", Complete: completeSubcommands, Description: `Commands to manually start or stop the daemon. The daemon process is normally started whenever you issue the first command (like »brig init« or later on a »brig ls«). Once you entered your password, it will be started for you in the background. Therefore is seldomely useful to use any of those commands - unless you know what you're doing. `, }, "daemon.launch": { Usage: "Start the daemon process in the foreground", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "trace,t", Usage: "Create tracing output suitable for `go tool trace`", }, }, Description: `Start the dameon process in the foreground. Note that the log will still be written to $BRIG_PATH/logs/main.log. You can change this behaviour by being explicit with --log-path: $ brig -l stdout daemon launch `, }, "daemon.quit": { Usage: "Quit a running daemon process", Complete: completeArgsUsage, Description: `Quit a running daemon process. If no daemon process is running, it will tell you. `, }, "daemon.ping": { Usage: "Check if the daemon is running and reachable", Complete: completeArgsUsage, Description: `Send up to 100 ping packages to the daemon and also print the roundtrip time for each. `, }, "config": { Usage: "View and modify config options", Complete: completeSubcommands, Description: `Commands for getting, setting and listing configuration values. Each config key is a dotted path, associated with one key. These configuration values can help you to finetune the behaviour of brig. For more details on each config value, type 'brig config ls'. `, }, "config.get": { Usage: "Get a specific config key", Complete: completeArgsUsage, ArgsUsage: "<key>", Description: `Show the current value of a key`, }, "config.doc": { Usage: "Show the docs for this config key", Complete: completeArgsUsage, ArgsUsage: "<key>", Description: `For each config key a few metadata entries are assigned. This includes a string describing the usage, the default value and an indicator if the service needs a restart when setting the value. `, }, "config.set": { Usage: "Set a specific config key to a new value", Complete: completeArgsUsage, ArgsUsage: "<key> <value>", Description: `Set the value at »key« to »value«. Keep in mind that it might be required to restart the daemon so the new values take effect. `, }, "config.list": { Usage: "List all existing config keys", Complete: completeArgsUsage, Description: `List all existing config keys. The output is valid YAML.`, }, "mount": { Usage: "Mount the contents of brig as FUSE filesystem", ArgsUsage: "<mount_path>", Complete: completeArgsUsage, Description: `Show the all files and directories inside a normal directory. This directory is powered by a userspace filesystem which allows you to read and edit data like you are use to from from normal files. It is compatible to existing tools and allows brig to interact with filebrowsers, video players and other desktop tools. It is possible to have more than one mount. They will show the same content. CAVEATS Editing large files will currenly eat huge amounts of memory. We advise you to use normal commands like »brig cat« and »brig stage« until this is fixed.`, }, "unmount": { Usage: "Unmount a previously mounted directory", ArgsUsage: "<mount_path>", Complete: completeArgsUsage, Description: `Unmount a previously mounted directory. All mounts get automatically unmounted once the daemon shuts down. In case the daemon crashed or failed to unmount, you can manually use this command to reclaim the mountpoint: $ fusermount -u -z /path/to/mount `, }, "version": { Usage: "Show the version of brig and ipfs", Complete: completeArgsUsage, Description: `Show the version of brig and ipfs. This includes the client and server version of brig. These two values should be ideally exactly the same to avoid problems. Apart from that, the version of ipfs is shown here. If available, also the git rev is included. This is useful to get the exact state of the software in case of problems. Additionally the build time of the binary is shown. Please include this information when reporting a bug. `, }, "gc": { Usage: "Trigger the garbage collector", Complete: completeArgsUsage, Flags: []cli.Flag{ cli.BoolFlag{ Name: "aggressive,a", Usage: "Also run the garbage collector on all filesystems immediately", }, }, Description: `Manually trigger the garbage gollector. Strictly speaking there are two garbage collectors in the system. The garbage collector of ipfs cleans up all unpinned files from local storage. This still means that the objects referenced there can be retrieved from other network nodes, but not locally anymore. This might save alot of space. The other garbage collector is not very important to the user and cleans up unused references inside of the metadata store. It is only run if you pass »--aggressive«. `, }, "docs": { Usage: "Open the online documentation in webbrowser", }, "bug": { Usage: "Print a template for bug reports", Flags: []cli.Flag{ cli.BoolFlag{ Name: "stdout,s", Usage: "Always print the report to stdout; do not open a browser", }, }, }, }
Functions ¶
Types ¶
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package tabwriter implements a write filter (tabwriter.Writer) that translates tabbed columns in input into properly aligned text.
|
Package tabwriter implements a write filter (tabwriter.Writer) that translates tabbed columns in input into properly aligned text. |
Click to show internal directories.
Click to hide internal directories.