Customization for the Code Companion on Software Factory

Code Companion - Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

The configuration of Code Companion has evolved to provide more readable, maintainable, and consistent configuration files. With the transition to YAML as the preferred format, users can benefit from new configuration options while simplifying their setup. This guide will help you migrate existing config.json files to config.yaml, outline new features, and highlight deprecated options.

The transition to YAML includes enhancements that align with future updates, facilitating a smoother integration process. As such, YAML configurations now take precedence over JSON, offering a more robust framework for customization.

Code Companion - Rules

Mon, 01 Jan 0001 00:00:00 +0000

How to Create and Manage Rules in Continue

Rules are used to provide system message instructions to the model for Agent mode, Chat mode, and Edit mode requests

Rules provide instructions to the model for Agent mode , Chat , and Edit requests.

Info

Rules are not included in autocomplete

Code Companion - Prompts

Mon, 01 Jan 0001 00:00:00 +0000

How to Create and Manage Prompts

Prompts are used to kick off tasks for Agent mode, Plan mode, and Chat mode

Prompts are included as user messages and are especially useful as instructions for repetitive and/or complex tasks.

Creating Prompts

You can create prompts in two ways:

1. Through the UI

Open the Code Companion sidebar in your IDE.
Go to the Rules section by selecting on the pen icon above the chat.

Code Companion - Context Providers

Mon, 01 Jan 0001 00:00:00 +0000

Context Providers

Context Providers allow you to type ‘@’ and see a dropdown of content that can all be fed to the LLM as context. Every context provider is a plugin, which means if you want to reference some source of information that you don’t see here, you can request (or build!) a new context provider.

Migrating from Deprecated Context Providers

If you were previously using the @Codebase or @Docs context providers, here’s how to migrate to the new approach:

Code Companion - Docs

Mon, 01 Jan 0001 00:00:00 +0000

Make Agent Mode Aware of Relevant Documentation

Documentation provides crucial context for agent mode to understand APIs, frameworks, and best practices.

Public Documentation - Rule

To guide agent mode to relevant documentation, you can start by creating a rule , for example:

# Documentation Resources

For framework-specific questions, refer to:

- React: https://react.dev/reference/react
- Next.js: https://nextjs.org/docs
- Tailwind CSS: https://tailwindcss.com/docs

Always cite documentation when explaining concepts.

Public Documentation - Prompt template

We also suggest adding this prompt template so you can automatically generate a documentation rule from any docs URL. Consider this template only a starting point, feel free to modify or extend it to fit your own docs and workflow.

Code Companion - Codebase Awareness

Mon, 01 Jan 0001 00:00:00 +0000

Codebase Awareness

Agent mode works best when it understands the context of your project. This guide shows you how to give agent mode access to codebases, making it more helpful and accurate.

Make Agent Mode Aware of Your Open Codebase

When agent mode understands your current codebase, it can provide more relevant suggestions and answers.

Initialize Codebase Awareness with `/init`

Before agent mode can effectively use your codebase, you can explicitly initialize it with the /init command in the chat input.

Customization for the Code Companion on Software Factory

Code Companion - Configuration

Introduction

Code Companion - Rules

How to Create and Manage Rules in Continue

Code Companion - Prompts

How to Create and Manage Prompts

Creating Prompts

1. Through the UI

Code Companion - Context Providers

Context Providers

Migrating from Deprecated Context Providers

Code Companion - Docs

Make Agent Mode Aware of Relevant Documentation

Public Documentation - Rule

Public Documentation - Prompt template

Code Companion - Codebase Awareness

Codebase Awareness

Make Agent Mode Aware of Your Open Codebase

Initialize Codebase Awareness with /init

Initialize Codebase Awareness with `/init`