Welcome to the world of Quivr, where your thoughts and ideas are seamlessly organized using the power of Generative AI. Much like your trusty assistant, Quivr streamlines your workflow and enhances productivity. In this article, we’ll walk you through the process of getting Quivr up and running on your local machine, ensuring you unleash the full potential of your second brain!

Key Features of Quivr

• Fast and Efficient: Rapid access to your data is guaranteed.
• Secure: You maintain complete control over your data at all times.
• OS Compatible: Quivr works flawlessly on Ubuntu 20 or newer.
• File Compatibility: Enjoy support for Text, Markdown, PDF, Powerpoint, Excel, CSV, Word, Audio, and Video files.
• Open Source: Quivr is free to use, respecting your freedom.
• Public/Private Options: Choose to share your knowledge or keep it to yourself.
• Offline Mode: Access your data anytime, even without an internet connection.

Getting Started with Quivr

Ready to bring your second brain to life? Follow these steps to deploy Quivr with ease!

Prerequisites

Before you start, ensure you have the following tools installed:

• Docker
• Docker Compose

Quick Installation Guide

Looking to get Quivr installed in 60 seconds? Watch the installation video here.

Step-by-Step Installation

1. Step 0: Install Supabase CLI

   Follow the instructions here to install the Supabase CLI.

   bash
   supabase -v # Check that the installation worked
   

2. Step 1: Clone the repository

   bash
   git clone https://github.com/quivrhq/quivr.git
   cd quivr
   

3. Step 2: Copy the Configuration File

   bash
   cp .env.example .env
   

4. Step 3: Update the Configuration File

   bash
   vim .env # You can use your preferred text editor
   

   In the .env file, locate and update the OPENAI_API_KEY variable with your API key, which you can obtain here. Make sure you create an account and enter your credit card information (you won’t be charged unless you use the API).

5. Step 4: Launch the Project

   bash
   cd backend
   supabase start
   cd ..
   docker compose pull
   docker compose up
   

   If you’re a Mac user, ensure that in Docker Desktop, under Settings > General, the file sharing implementation is set to VirtioFS.

6. Step 5: Log into the App

   Access the app by signing in with admin@quivr.app and the password admin. You can find the app at http://localhost:3000/login and the backend API at http://localhost:5050/docs.

Updating Quivr

To keep your Quivr fresh and updated, follow these simple steps:

1. Step 1: Pull the latest changes.

bash
git pull

2. Step 2: Update the migration.

bash
supabase migration up

Troubleshooting

If you run into issues during installation or while using Quivr, here are some potential solutions:

• Ensure that Docker and Docker Compose are correctly installed and running.
• Verify your OPENAI_API_KEY is accurate and has not expired.
• If you have difficulties with the Supabase CLI, double-check the installation steps listed in their documentation.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Your Personal Assistant Awaits!

Your journey with Quivr offers immense potential. By organizing and harnessing your knowledge, you empower your next great idea. Start now, and enjoy a smarter way to manage your thoughts!