#How Do I Get Warp to Create a WARP.md File?

19 messages · Page 1 of 1 (latest)

fallen wave
#

How Do I Get Warp to Create a WARP.md File?

scarlet gazelleBOT
#

Hi @fallen wave. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:

#

To get Warp to create a WARP.md file, you should use the /init slash command while inside your project directory. Here’s how it works:

  1. Open Warp and navigate to your project directory.
  2. Run the /init command in Auto or Natural language mode.

This will:

  • Begin indexing your codebase (or show indexing status).
  • Generate a WARP.md file with initial context in your project root, or
  • Link an existing rules file (such as CLAUDE.md, AGENT.md, etc.) to WARP.md if one is present.

The WARP.md file acts as your project’s rule definition file, allowing you to define project-specific coding standards and guidelines that Warp’s agents will follow. You can version-control this file along with your codebase for team collaboration and consistency How to create, edit, or delete Rules Projects: WARP.md, slash commands, and agent profiles.

If you have an existing project that hasn’t been initialized, you can always run /init manually to bootstrap it with a version-controlled WARP.md file Getting Started With Coding in Warp.

Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:

#

@fallen wave Kapa.ai is still learning and improving, please let me know how I did by reacting below.

halcyon lake
#

I'm piggybacking this - warp just won't see the WARP.md file I created. does it have a certain format?

halcyon lake
#

hey @scarlet gazelle help me

scarlet gazelleBOT
#

Let me check the knowledge base for you again. One moment! :books:

#

Of course! To get Warp to create a WARP.md file for your project, follow these steps:

  1. Open Warp and navigate to your project directory.
  2. Run the /init slash command in the terminal.

Warp will then initialize your project, index your codebase, and generate a WARP.md file in the root of your repository. This file is used to define project-specific rules and guidelines for Warp’s agents. If your project already has a WARP.md, Warp will use the existing one. You can also manually create a WARP.md file if needed, but using /init is the recommended approach for automatic setup and indexing Getting Started With Coding in Warp Projects: WARP.md, slash commands, and agent profiles.

Let me know if you need more details or run into any issues!

Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:

#

@halcyon lake Kapa.ai is still learning and improving, please let me know how I did by reacting below.

halcyon lake
#

@scarlet gazelle

scarlet gazelleBOT
#

Let me check the knowledge base for you again. One moment! :books:

#

Sorry @halcyon lake, I seem to be having a bit of trouble. Don't worry though, I've pinged my support and they will try to fix me up! :technologist:

Perhaps try again in 15mins?

halcyon lake
#

@scarlet gazelle /init doesn't do anything

scarlet gazelleBOT
#

Let me check the knowledge base for you again. One moment! :books:

#

If running /init in Warp doesn't do anything, the knowledge sources do not provide a detailed troubleshooting guide for this specific issue. However, based on the documentation, /init is supposed to initialize your project by indexing your codebase and generating a WARP.md file or linking an existing rules file if present. If this is not happening, it may indicate a bug or an issue with your Warp installation or environment.

Here are a few steps you can try, based on related issues and documentation:

  • Make sure you are in the correct project directory when running /init.
  • Ensure you are using the latest version of Warp.
  • Try restarting Warp and running /init again.
  • If the problem persists, consider checking the Warp known issues page or opening a bug report with details about your environment and what you observe.

Unfortunately, the knowledge sources do not contain more specific troubleshooting steps for /init not working. If you provide more details (such as error messages or logs), I may be able to help further.

Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:

#

@halcyon lake Kapa.ai is still learning and improving, please let me know how I did by reacting below.

fallen wave
#

/init certainly works - it indexes your codebase and will optionally create the WARP.md file. Are you on the latest version @halcyon lake ?

dark thicket
#

/init definitely works and creates the md file. But it was only recently introduced, so maybe upgrade warp.