How to Use Plandex

Getting started with Plandex

In this guide, you will learn how to set up and use Plandex, an open-source terminal AI coding engine, to assist with complex multi-file coding tasks. By the end, you'll be ready to start coding more efficiently with AI support.

Step 1: Sign up and set up

1. Go to plandex.ai.
2. Click on the "Get Started" button on the homepage.
3. Fill out the sign-up form with your email and create a password.
4. Confirm your email address by clicking the link in the verification email.
5. Once verified, log in to your Plandex account.

Step 2: Your first coding task

1. Open your terminal and type plandex init to create a new project directory.
2. Navigate to your project directory using cd your-project-name.
3. To start a new coding task, type plandex start followed by a brief description of what you need help with. For example, plandex start "Create a function to calculate Fibonacci numbers".
4. Plandex will generate code snippets and suggest files where the code can be implemented.
5. Review the suggestions and select the one that fits your needs by typing the corresponding number.
6. Plandex will then create the necessary files and add the code for you.

Step 3: Get better results

• Use specific prompts when asking for help. Instead of saying "fix my code," provide context, such as "optimise this sorting algorithm for large datasets."
• Explore the plandex help command to view available commands and options.
• Collaborate with others by using the plandex share command to send your project files to teammates.

Pro tip

Use the plandex config command to personalise your settings. You can adjust parameters like coding styles or preferred programming languages, which can save you time in generating code that meets your specific needs.

Common mistake to avoid

Avoid vague requests. If you ask Plandex to "help with my project," it may not provide useful results. Always be clear and specific about the task you need assistance with.