> For the complete documentation index, see [llms.txt](https://docs.revault.onepub.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.revault.onepub.dev/quick-start-guide.md). # Quick start guide No cruft just the juicy bits. If you don't have cargo (the rust package manager) follow the cargo install guide: Once cargo is installed Install reVault: ``` cargo install revault_cli ``` We assume here that the cargo bin directory is on your path. Do the one time initialisation of your vault ``` lbx vault init ``` This will generate a CRITICAL pass phrase - store it someplace VERY safe and do not lose. If you lose it you lose access to all of your lockboxes and we can do nothing to help you!!!!! Create a lockbox: ``` lbx create mystuff.lbox ``` Set the lockbox as active (you don't need to do this but it reduces typing). ``` lbx session activate mystuff.lbox ``` Add a file to a lockbox: ``` lbox add reamde.md ``` Add a directory: ``` lbox add /home/me ``` Add a file, but store it in a directory in the lockbox: ``` lbox add readme.md /some/place/in/the/lockbox ``` List the contents of the active lockbox: ``` lbx ls ``` Find all .md files in the lockbox ``` lbx ls *.md ``` Remove a file from the lockbox: ``` lbx rm readme.md ``` Add a variable: ``` lbox var set DBPORT 80 lbox var set --secret PASSWORD --file /my/db/password.txt lbox var set name "A developer" lbox var set /production/DBPORT 80 ``` Get a variable ``` lbox var get DBPORT lbox var get --secret PASSWORD lbox var get /production/DBPORT ``` Delete a variable: ``` lbox var rm DBPORT ``` Export a variable: ``` lbx var export --format posix DBPORT='80' lbx var export --format powershell $env:DBPORT = '80' ``` Create a form definition: TODO: complete form examples ``` lbx form ``` Share a lockbox: Have an associate install reVault and then ask the to run: ``` lbx vault publish ``` Ask them for the share code and finger print (make certain you initiate the conversation to avoid being being hacked by AI). On your machine run: ``` lbx vault receive ``` Enter the fingerprint when prompted. Now give your associate access to the lockbox: ``` lbox access add ``` You can share access to any number of contacts to the lockbox. You can now safely email the lockbox to each contact. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.revault.onepub.dev/quick-start-guide.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.