Skip to main content

ValorIDE Prompting Guide

Use this guide to write effective prompts and configure Custom Instructions that make ValorIDE a consistent, safe, and productive teammate.

Custom Instructions​

Custom instructions are persistent project or user preferences that shape ValorIDE's behavior. Add them via the ValorIDE extension settings under "Custom Instructions".

Recommended uses:

  • Enforce coding standards and patterns
  • Protect secrets (never modify or read .env, .pem files)
  • Define testing and quality gates for PRs

.valoriderules (project rules)​

.valoriderules are project-specific rules that are appended automatically to ValorIDE's system prompt when the workspace is opened. Use them for repository-level guardrails.

Prompting patterns​

  • Provide succinct goals
  • Attach context with @file, @folder, @url when relevant
  • Break tasks into small, reviewable steps

For advanced guidance, check the Prompt Engineering page and the Custom Instructions Library entries in this section.

ValorIDE Prompting Guide 🚀 (Now with Extra Sass!)

Welcome to the wild and wonderful world of ValorIDE prompting! This guide is your trusty sidekick to crafting prompts and custom instructions that’ll make ValorIDE dance to your tune — and maybe even tell a joke or two.

Custom Instructions ⚙️ (Because Robots Need Rules Too)​

Custom instructions are like ValorIDE’s secret sauce — always simmering in the background, making sure it behaves just the way you want. Think of them as the ultimate “do this, not that” list for your AI buddy.

How to Add Custom Instructions (No Magic Wands Required)​

  1. Fire up VSCode (your new best friend).
  2. Click the little gear ⚙️ on the ValorIDE extension (it’s shy but helpful).
  3. Find the “Custom Instructions” box — it’s waiting for your wisdom.
  4. Paste your instructions like a boss.

Why Bother with Custom Instructions?​

  • Keep It Classy: Make sure ValorIDE doesn’t go rogue with your coding style.
  • Code Like a Pro: Get code so clean, even your grandma would approve.
  • Error Handling Like a Champ: Tell ValorIDE how to freak out gracefully when things go sideways.

The custom-instructions folder is your treasure chest of examples — feel free to raid it.

The .valoriderules File 📋 (Your Project’s Rulebook)​

While custom instructions are like your AI’s personal trainer, .valoriderules is the project’s drill sergeant. It lives in your project’s root and keeps everyone in line — including ValorIDE.

Security Best Practices 🔒 (Because Secrets Should Stay Secret)​

Tell ValorIDE to steer clear of your secret stuff:

  • .env files (shhh!)
  • Config files with the good stuff
  • Private keys and tokens (no peeking!)

Example .valoriderules snippet:

# Security

## Sensitive Files

DO NOT read or touch:

- .env files
- \*_/config/secrets._
- \*_/_.pem
- Any file with API keys, tokens, or other juicy secrets

## Security Practices

- Never commit secrets (unless you want to cry)
- Use environment variables like a grown-up
- Keep credentials out of logs (nobody likes oversharers)

Other Cool Uses​

  • Keep your team on the same page
  • Enforce your weird but wonderful dev habits
  • Manage docs like a boss
  • Set up fancy analysis and review stuff
  • Make your project uniquely yours

Sample .valoriderules Structure​

# Project Guidelines

## Documentation

- Update docs when you change stuff
- Keep R E A D M E updated
- Log changes in CHANGELOG.md

## Architecture Decision Records

Create ADRs for:

- Big dependency moves
- Architecture shake-ups
- New integration magic
- Database schema wizardry
  Follow `/docs/adr/template.md`

## Code Style & Patterns

- Use OpenAPI Generator for API clients
- TypeScript axios template FTW
- Generated code goes in `/src/generated`
- Composition > inheritance (always)
- Repository pattern for data access
- Follow error handling in `/src/utils/errors.ts`

## Testing Standards

- Unit tests for your brainy logic
- Integration tests for API hookups
- E2E tests for the big picture

Why You’ll Love .valoriderules​

  1. It’s version controlled (no sneaky changes)
  2. Keeps your team singing the same tune
  3. Tailors rules to your project’s quirks
  4. Saves your team’s collective brainpower

Drop .valoriderules in your project root like this:

your-project/
├── .valoriderules
├── src/
├── docs/
└── ...

Heads up: ValorIDE’s system prompt is locked down (peek here). For prompt wizardry, check out Anthropic’s guide.

Tips for Writing Killer Custom Instructions​

  • Keep it simple, smarty.
  • Focus on what you want, not how to get it.
  • Tweak and test like a mad scientist.

Prompting ValorIDE 💬 (Talk Nerdy to Me)​

Prompting is your chat with ValorIDE. It gets natural language, so talk like you’re chatting with your favorite coder buddy.

Good prompts:

  • Give clear context: goals, files, folders (use @ to tag)
  • Break big tasks into bite-sized chunks
  • Ask specific questions (no vague vibes)
  • Review and tweak ValorIDE’s answers

Prompt Examples​

Context Management​

  • Kickoff a Task:
    "ValorIDE, start a new task. Create user-authentication.js with JWT login. Here’s the scoop…"

  • Recap Time:
    "ValorIDE, summarize our last dashboard work. What’s done, what’s pending? Save to valoride_docs/user-dashboard-summary.md."

Debugging​

  • Error Detective:
    "ValorIDE, I got this error: [error message]. It’s from [code section]. Help me fix it."

  • Root Cause Sleuth:
    "ValorIDE, app crashes when I [action]. Suspect [areas]. Find the culprit."

Refactoring​

  • Simplify This:
    "ValorIDE, this function’s a beast. Break it into smaller, friendlier parts."

  • Make It Pretty:
    "ValorIDE, clean up this code so it’s easier on the eyes."

Feature Brainstorming​

  • Idea Factory:
    "ValorIDE, brainstorm features for letting users [functionality]. What could go wrong?"

  • Code Genie:
    "ValorIDE, whip up a sortable, filterable user profile component."

Advanced Prompting Tricks​

  • Constraint Stuffing:
    Say stuff like "give me full code" or "don’t cut off functions" to avoid cliffhangers.

  • Confidence Meter:
    Ask ValorIDE to rate its confidence (1-10).

  • Challenge Accepted:
    Ask “dumb” questions to make ValorIDE think harder.

Community Faves 🌟​

Memory & Confidence Checks 🧠​

  • Memory Check:
    "If you get my prompt, say 'YARRR!' before using any tools."

  • Confidence Score:
    "Rate confidence (0-10) before and after tool use."

Code Quality Prompts 💻​

  • No Lazy Code:
    "DO NOT BE LAZY. DO NOT OMIT CODE."

  • Custom Instructions Pledge:
    "I pledge to follow the custom instructions."

Code Organization 📋​

  • Big File SOS:
    "FILENAME is huge. Suggest safe ways to split it."

  • Doc Reminder:
    "Update docs when you change code."

Planning & Analysis 🔍​

  • Plan Before Code:
    "Analyze all files, get context, write plan, then code."

  • Deep Dive:
    "Analyze full flow, rate confidence 1-10."

  • Clear Assumptions:
    "List assumptions before starting."

Thoughtful Development 🤔​

  • Pause Button:
    "Count to 10 before acting."

  • Keep Digging:
    "Don’t stop analyzing even if you think you’re done."

  • Confidence Check:
    "Rate confidence before and after saving, and before finishing."

Best Practices 🎯​

  • Check Files First:
    "Look at project files before suggesting big changes."

  • Ask Dumb Questions:
    "Are you sure this is the best way?"

  • Use Fancy Words:
    "Use 'elegant' and 'simple' in prompts."

  • Warning:
    "THE HUMAN WILL GET ANGRY." (Be clear and kind!)