Prisma Assistant

What is Prisma Assistant?

Prisma Assistant is an innovative tool designed for developers that allows for interactive communication with their database schema. It provides insights and enables code generation directly within the development environment, enhancing workflow efficiency and facilitating easier project management.

Main Features of Prisma Assistant

1. Conversational Interaction: Gain insights into your database schema through natural language queries.

2. Code Generation: Automatically generate code snippets based on conversational interactions.

3. User-Friendly Environment: Integrate seamlessly with your existing development environment for heightened productivity.

How to Use Prisma Assistant

To get started with Prisma Assistant, follow these steps:

1. Obtain an OpenAI API Key: Sign up at the OpenAI API portal to get your unique API key.

2. Set Environment Variables:

   • For MacOS/Linux, run:

     export PRISMA_ASSISTANT_OPENAI_API_KEY=your_openai_api_key
     

   • For Windows, run:

     set PRISMA_ASSISTANT_OPENAI_API_KEY=your_openai_api_key
     

3. Start the Prisma Assistant Server:

   Run the following command in your terminal at the root of your Prisma project:

   npx prisma-assistant@latest
   

4. Access the UI: After starting the server, access the provided URL in your web browser to interact with Prisma Assistant.

Optional Environment Variables

You can customize the behavior of Prisma Assistant by setting optional environment variables:

• PRISMA_ASSISTANT_OPENAI_MODEL: Specify the model ID to use.

• PRISMA_ASSISTANT_OPENAI_API_BASE_URL: Override the default API base URL for tailored requirements.

Security Considerations

Keep your OpenAI API key secure since it is sensitive information. Prisma Assistant operates entirely on your machine, meaning your API key is never shared or exposed.

Helpful Tips

• Ensure your terminal is configured to preserve environment variables for persistent use.
• Regularly check for updates on Prisma Assistant as it is currently in early alpha.
• Experiment with various queries to explore the full scope of functionalities Prisma Assistant offers.

Frequently Asked Questions

Can I use Prisma Assistant on any operating system?

Yes, Prisma Assistant can be utilized on MacOS, Linux, and Windows, with specific commands for each environment.

What should I do if I encounter issues with the OpenAI API key?

Make sure that your API key is set correctly in the environment variables and that there are no typographical errors.

Will my API key be stored by Prisma Assistant?

No, your OpenAI API key is only used during your local session and is not stored or shared by Prisma Assistant.

How can I stay informed about new features?

You can opt-in to receive updates by subscribing to notifications offered on the Prisma Assistant platform.