perkeep/cmd/pk-get/doc.go

40 lines
1.1 KiB
Go

/*
Copyright 2013 The Perkeep Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/*
The pk-get tool fetches blobs, files, and directories.
Examples
Writes to stdout by default:
pk-get <blobref> // dump raw blob
pk-get -contents <file-blobref> // dump file contents
Like curl, lets you set output file/directory with -o:
pk-get -o <dir> <blobref>
(if <dir> exists and is directory, <blobref> must be a directory;
use -f to overwrite any files)
pk-get -o <filename> <file-blobref>
Camget isn't very fleshed out. In general, using 'pk-mount' to just
mount a tree is an easier way to get files back.
*/
package main // import "perkeep.org/cmd/pk-get"