.TH TAHOE 1 "March 2025" "Tahoe-LAFS \[em] tahoe command" "User Commands" .SH NAME tahoe \- Secure distributed file store. .SH SYNOPSIS .B tahoe [\fI\,global-options\/\fR] \fI\, \/\fR[\fI\,command-options\/\fR] .SH DESCRIPTION Tahoe-LAFS offers provider-independent security for your data. You don't have to trust Tahoe-LAFS storage nodes for confidentiality or integrity - both are provided through cryptography. Additionally, Tahoe-LAFS helps with availability and anonymity. The `tahoe' command line application is a single program offering access to almost all of Tahoe-LAFS' functionality. Brevity permits only a succinct overview, and even then, not all commands and options can be covered here. Please have a look at the `SEE ALSO' section at the end of this manual page for pointers to further instructions. . .SH GLOBAL OPTIONS .TP \fB\-d\fR, \fB\-\-node\-directory=\fR Specify which Tahoe node directory should be used. The directory should either contain a full Tahoe node, or a file named node.url that points to some other Tahoe node. It should also contain a file named 'private/aliases' which contains the mapping from alias name to root dirnode URI. [default for most commands: \&`$HOME/.tahoe'] .TP \fB\-\-eliot\-destination=\fR Add an Eliot logging destination. May be given more than once. .TP \fB\-\-help\fR Display help and exit. .TP \fB\-\-help\-eliot\-destinations\fR Emit usage information for \fB\-\-eliot\-destination\fR. .TP .B \f[B]-q,\ --quiet\f[] Operate silently. .RS .RE .TP .B \f[B]-V,\ --version\f[] Display version numbers. .RS .RE .TP .B \f[B]--version-and-path\f[] Display version numbers and paths to their locations. .RS .RE .TP \fB\-\-wormhole\-invite\-appid=\fR The appid to use on the wormhole server. [default: tahoe\-lafs.org/invite] .TP \fB\-\-wormhole\-server=\fR The magic wormhole server to use. [default: ws://wormhole.tahoe\-lafs.org:4000/v1] .SH COMMANDS .PP The \f[B]tahoe\f[] runner can be used for various tasks depending on the command used. .SS ADMINISTRATION .PP tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] .RS .SS COMMANDS .TP .B \f[B]create-node\f[] Create a node that acts as a client, server or both. .TP .B \f[B]create-client\f[] Create a client node (with storage initially disabled). .TP .B \f[B]create-introducer\f[] Create an introducer node. .SS OPTIONS .TP .B \f[B]-C,\ --basedir=\f[] Same as \[em]node-directory. .TP .B \f[B]-d,\ --node-directory=\f[] Specify which Tahoe node directory should be used. (default for \f[B]create-node\f[] and \f[B]create-client\f[]: `$HOME/.tahoe/'). .TP .B \f[B]-n,\ --nickname=\f[] Specify the nickname for this node (\f[B]create-node\f[] and \f[B]create-client\f[] only). .TP .B \f[B]-i,\ --introducer=\f[] Specify the introducer FURL to use (\f[B]create-node\f[] and \f[B]create-client\f[] only). .TP .B \f[B]-p,\ --webport=\f[] Specify which TCP port to run the HTTP interface on. Use `none' to disable. Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and \f[B]create-client\f[] only). .TP .B \f[B]--no-storage\f[] Do not offer storage service to other nodes (\f[B]create-node\f[] only). .RE .SS CONTROLLING NODES .PP tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] .SS COMMANDS .TP .B \f[B]run\f[] Run a node without daemonizing. This is the only option for running nodes. In the past, tahoe offered service watching internally (with start, restart, stop commands), but this was and not very portable and has been deprecated. .RS .RE .SS OPTIONS .TP .B \f[B]--allow-stdin-close\f[] Do not exit when stdin closes ("tahoe run" otherwise will exit). This is required for some service runners (like systemd, for example). .RS .RE .TP .B \f[B]-C,\ --basedir=\f[] Specify which Tahoe base directory should be used. This has the same effect as the global --node-directory option. [default: '$HOME/.tahoe'] .RS .RE .TP .B \f[B]--help\f[] Display help and exit. This includes lots of `twistd-options' for debugging, logging, profiling, et cetera that are left out of this manual page for brevity. .RS .RE .SS USING THE FILE STORE .TP .B \f[B]mkdir\f[] Create a new directory. .RS .RE .TP .B \f[B]add-alias\f[] Add a new alias cap. .RS .RE .TP .B \f[B]create-alias\f[] Create a new alias cap. .RS .RE .TP .B \f[B]list-aliases\f[] List all alias caps. .RS .RE .TP .B \f[B]ls\f[] List a directory. .RS .RE .TP .B \f[B]get\f[] Retrieve a file from the grid. .RS .RE .TP .B \f[B]put\f[] Upload a file into the grid. .RS .RE .TP .B \f[B]cp\f[] Copy one or more files or directories. .RS .RE .TP .B \f[B]unlink\f[] Unlink a file or directory on the grid. .RS .RE .TP .B \f[B]rm\f[] Unlink a file or directory on the grid (same as \f[B]unlink\f[]). .RS .RE .TP .B \f[B]mv\f[] Move a file within the grid. .RS .RE .TP .B \f[B]ln\f[] Make an additional link to an existing file or directory. .RS .RE .TP .B \f[B]backup\f[] Make target dir look like local dir. .RS .RE .TP .B \f[B]webopen\f[] Open a web browser to a grid file or directory. .RS .RE .TP .B \f[B]manifest\f[] List all files/directories in a subtree. .RS .RE .TP .B \f[B]stats\f[] Print statistics about all files/directories in a subtree. .RS .RE .TP .B \f[B]check\f[] Check a single file or directory. .RS .RE .TP .B \f[B]deep-check\f[] Check all files/directories reachable from a starting point .RS .RE .SS OPTIONS .PP Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each command. .SS DEBUGGING .PP tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... .SS SUBCOMMANDS .TP .B \f[B]dump-share\f[] Unpack and display the contents of a share. .RS .RE .TP .B \f[B]dump-cap\f[] Unpack a read-cap or write-cap. .RS .RE .TP .B \f[B]find-shares\f[] Locate sharefiles in node directories. .RS .RE .TP .B \f[B]catalog-shares\f[] Describe all shares in node dirs. .RS .RE .TP .B \f[B]corrupt-share\f[] Corrupt a share by flipping a bit. .RS .RE .PP Please run e.g.\ `tahoe debug dump-share --help' for more details on each subcommand. .SH AUTHORS .PP Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn and dozens of others. This manpage was originally written by bertagaz. .SH REPORTING BUGS .PP Please see . .PP For known security issues see . .PP Tahoe-LAFS home page: .PP tahoe-dev mailing list: .SH COPYRIGHT .PP Copyright \@ 2006\[en]2013 The Tahoe-LAFS Software Foundation .SH "SEE ALSO" Run 'tahoe \fB\-\-help\fR' for an overview of commands and 'tahoe \fB\-\-help\fR' for more details on each command. See .UR https://tahoe-lafs.readthedocs.io/ .UE for more in-depth, longer-form documentation and step-by-step tutorials. See .UR https://tahoe-lafs.readthedocs.io/en/tahoe-lafs-1.20.0/frontends/CLI.html .UE for user documentation specific to the 'tahoe' command.