Home Explore Blog Models CI



ragit

docs/commands/archive-create.txt
bcefd907be5122d3d19ad66176425e24d2e1fd48d5acdf1d000000030000057a
rag-archive-create(1)
==========

NAME
----
rag-archive-create - Create an archive of a knowledge-base
rag-create-archive - Alias
rag-archive - Alias

SYNOPSIS
--------
[verse]
'rag archive-create' [--jobs <n=4>] [--size-limit <n>] [--[no-]configs]
            [--[no-]prompts] [--[no-]queries] [--force | -f] [--quiet | -q]
            --output | -o <file>

DESCRIPTION
-----------
You can create an archive of a knowledge-base. You can easily store and share
your knowledge-base. `rag pull` and `rag clone` also send and receive archive
files.

If `--size-limit` is not set, it creates a single file. If the limit is set,
it tries its best to keep each file smaller than `n` bytes. It behaves oddly
if the size limit is too small. Please keep size limit greater than 4 KiB.

By default, the archives do not include configs, prompts and query histories.
If you extract such archives, the knowledge-bases will have default configs,
default prompts and no query histories. You can override this behavior
with `--configs`, `--prompts` and `--queries` option.

By default, it raises an error if the output file already exists. You can
forcefully write to the file with `--force` option. If something goes wrong
while forcefully writing to a file, you might lose the original data. Be careful.

The created archive does not include inverted index. You have to run `ii-build`
after you extract the archive.

Chunks
974527e3 (1st chunk of `docs/commands/archive-create.txt`)
Title: rag-archive-create Command
Summary
The rag-archive-create command creates an archive of a knowledge-base, allowing for easy storage and sharing, with options to customize the archive contents, such as including or excluding configs, prompts, and query histories, and specifying output file settings, including size limits and overwrite behavior.