> ## Documentation Index
> Fetch the complete documentation index at: https://docs.replit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# replit.md

> Saiba como usar o replit.md para personalizar o comportamento do Agent, o estilo de codificação e o contexto do projeto.

export const YouTubeEmbed = ({videoId, title = "YouTube video", startAt}) => {
  if (!videoId) {
    return null;
  }
  let url = "https://www.youtube.com/embed/" + videoId;
  if (startAt) {
    url = url + "?start=" + startAt;
  }
  return <Frame>
      <iframe src={url} title={title} allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowFullScreen></iframe>
    </Frame>;
};

O Agent cria automaticamente este arquivo no diretório raiz do seu projeto usando práticas recomendadas comprovadas. O Agent inclui seu conteúdo no contexto para ajudá-lo a entender suas preferências, estrutura do projeto e estilo de codificação.

<Frame>
  <img src="https://mintcdn.com/replit/0UCOQvZyQpUEM03B/images/replitai/replitmd.jpg?fit=max&auto=format&n=0UCOQvZyQpUEM03B&q=85&s=63b53f2f18d59701e9b9a08d36663eaa" alt="Agent usando replit.md para construir um projeto" width="1920" height="1080" data-path="images/replitai/replitmd.jpg" />
</Frame>

## Como o `replit.md` funciona

O Agent primeiro cria um arquivo `replit.md` no diretório raiz do seu projeto usando práticas recomendadas comprovadas. Este arquivo inclui:

* Informações básicas do projeto
* Padrões de codificação recomendados
* Preferências comuns para o tipo do seu projeto

<YouTubeEmbed videoId="kYv525W-vaU" title="Personalize como o Replit Agent responde" />

Quando o Agent processa suas solicitações, ele lê automaticamente o arquivo `replit.md` e usa seu conteúdo para:

* Entender a arquitetura e as convenções do seu projeto
* Seguir seus padrões e estilos de codificação preferidos
* Usar os gerenciadores de pacotes e dependências especificados

O Agent também pode atualizar o arquivo `replit.md` à medida que aprende mais sobre o seu projeto e faz alterações na sua aplicação.

<Note>
  Você pode editar o arquivo `replit.md` para personalizar o comportamento do Agent.
</Note>

## Configurando o `replit.md`

### Geração automática

Quando você cria um novo projeto com o Agent, ele gera automaticamente um arquivo `replit.md` usando práticas recomendadas comprovadas. Este arquivo aparece no diretório raiz do seu projeto e inclui:

* Informações básicas do projeto
* Padrões de codificação recomendados
* Preferências comuns para o tipo do seu projeto

### Criação manual

Você pode criar seu próprio arquivo `replit.md` adicionando um novo arquivo chamado `replit.md` no diretório raiz do seu projeto. O Agent detectará e usará automaticamente esse arquivo em conversas futuras.

<Note>
  O `replit.md` deve estar localizado no diretório raiz do seu projeto para funcionar corretamente.
</Note>

### Regenerando o `replit.md`

Se o arquivo `replit.md` ficar corrompido ou você quiser começar do zero:

1. Delete o arquivo `replit.md` existente do diretório raiz do seu projeto
2. Inicie uma nova conversa com o Agent
3. O Agent gerará automaticamente um novo arquivo `replit.md` com base no seu projeto atual

## Práticas recomendadas

### Seja específico e claro

Escreva instruções claras e específicas que ajudem o Agent a entender exatamente o que você quer:

```markdown theme={null}
## Coding Style

- Use TypeScript for all new JavaScript files
- Prefer functional components with hooks over class components
- Use Tailwind CSS for styling, avoid inline styles
- Always include TypeScript types for function parameters and return values
```

Para um guia mais detalhado sobre formatação de prompts, confira o [guia de engenharia de prompts da Anthropic](https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags).

### Use exemplos

Exemplos ajudam o Agent a entender suas preferências melhor do que descrições abstratas:

````markdown theme={null}
## API Error Handling

When creating API endpoints, always use this error handling pattern:

```javascript
app.get('/api/users', async (req, res) => {
  try {
    const users = await getUsersFromDatabase();
    res.json({ success: true, data: users });
  } catch (error) {
    console.error('Error fetching users:', error);
    res.status(500).json({ 
      success: false, 
      error: 'Failed to fetch users' 
    });
  }
});
````

### Defina preferências de comunicação

Diga ao Agent como você prefere receber informações e atualizações:

```markdown theme={null}
## Communication Style

- Before implementing changes, explain what you're going to do and why
- Break down complex tasks into clear steps
- Ask for clarification if requirements are unclear
- Provide brief explanations for technical decisions
```

### Especifique o contexto do projeto

Ajude o Agent a entender o propósito e as restrições do seu projeto:

```markdown theme={null}
## Project Context

This is a social media app for book lovers where users can:
- Create reading lists and share book recommendations
- Follow other readers and see their updates
- Rate and review books they've read

Target audience: Casual readers aged 25-45
Tech stack: React frontend, Node.js backend, PostgreSQL database
```

## Exemplos de configurações do `replit.md`

### Projeto de aplicação web

```markdown theme={null}
# MyApp Project Guidelines

## Project Overview
A task management web application built with React and Express.js.

## Technology Preferences
- Frontend: React with TypeScript, Tailwind CSS
- Backend: Express.js with TypeScript
- Database: Neon PostgreSQL with Drizzle ORM
- Package Manager: npm (not yarn or pnpm)

## Coding Standards
- Use functional components with hooks
- Implement proper error boundaries
- Follow REST API conventions for endpoints
- Use descriptive variable and function names

## Communication Style
- Explain your approach before making changes
- Provide code comments for complex logic
- Ask questions if requirements are ambiguous
```

### Projeto de análise de dados

```markdown theme={null}
# Data Analysis Project Guidelines

## Project Context
Analyzing customer behavior data to identify trends and insights.

## Technology Preferences
- Python with Streamlit for interactive web applications
- pandas, numpy, and matplotlib for data analysis

## Analysis Standards
- Include clear documentation for all analysis steps
- Create interactive visualizations with Streamlit components
- Validate data quality before analysis
- Export results to CSV format and display in Streamlit tables

## Communication Style
- Explain statistical methods and assumptions
- Provide context for findings and recommendations
- Use clear, non-technical language for business insights
- Create interactive dashboards for stakeholder presentations
```

### Projeto de desenvolvimento de API

```markdown theme={null}
# API Development Guidelines

## Project Overview
Building a RESTful API for a mobile app backend.

## Technology Stack
- Node.js with Express.js
- MongoDB with Mongoose
- JWT for authentication
- Package manager: npm

## API Standards
- Use semantic HTTP status codes
- Implement proper input validation
- Include rate limiting on public endpoints
- Follow OpenAPI specification for documentation

## Security Requirements
- Validate all user inputs
- Use environment variables for sensitive data
- Implement proper CORS policies
- Include request logging for debugging

## Testing Approach
- Write unit tests for all endpoints
- Include integration tests for critical flows
- Use Jest as the testing framework
```

## Uso avançado

### Orientação dinâmica do projeto

Atualize o arquivo `replit.md` à medida que o projeto evolui para fornecer contexto atualizado:

```markdown theme={null}
## Current Development Phase
The team is currently focused on implementing user authentication.
Priority features:
1. User registration and login
2. Password reset functionality  
3. Email verification

## Recent Decisions
- Switched from local authentication to OAuth with Google
- Added Redux for state management
- Decided to use Material-UI for consistent styling
```

### Integração com ferramentas externas

Referencie documentação externa e ferramentas no seu `replit.md`:

```markdown theme={null}
## External Resources
- Design system: Follow the Figma design system at [link]
- API documentation: Reference our internal API docs
- Coding standards: Follow the team style guide in our wiki

## Deployment Process
- Test changes in development environment first
- Use the CI/CD pipeline for staging published apps
- Require code review before production releases
```

## Combinando pesquisa na web com `replit.md`

O Agent pode realizar pesquisas na web para encontrar informações atuais, bibliotecas e soluções. Combinado com o arquivo `replit.md`, você obtém tanto conhecimento atualizado quanto orientação específica do projeto.

### Práticas recomendadas para integração com pesquisa na web

**Seja específico sobre o que você quer que o Agent pesquise:**

```markdown theme={null}
## Research Preferences
- Always check for the latest versions of dependencies before suggesting updates
- Research current best practices for security implementations
- Look up recent performance optimization techniques for our tech stack
```

**Oriente o Agent sobre como aplicar o conhecimento externo:**

```markdown theme={null}
## External Research Guidelines
- When suggesting new libraries, ensure compatibility with our existing stack
- Adapt external examples to match our coding standards and project structure  
- Verify that suggested solutions work with our publishing environment
```

**Exemplo de solicitação que aproveita ambos:**
"Pesquise as técnicas mais recentes de otimização de desempenho do React 18 e implemente-as seguindo os padrões de componentes definidos no `replit.md`"

Esta abordagem fornece soluções que são tanto atuais quanto adaptadas às necessidades específicas do seu projeto.

## Limitações

### Limites de tamanho e conteúdo do arquivo

Embora não haja limite estrito de caracteres para o `replit.md`, arquivos muito grandes podem não ser processados completamente. Mantenha o `replit.md` focado e conciso para obter melhores resultados.

### Requisito de diretório raiz

O `replit.md` deve existir no diretório raiz do seu projeto. O Agent não detectará automaticamente arquivos em subdiretórios.

### Escopo do contexto

O `replit.md` fornece contexto para conversas com o Agent, mas não se aplica automaticamente a outras ferramentas de IA.

## Próximos passos

Pronto para personalizar o Agent para o seu projeto?

1. **Comece simples**: Crie um `replit.md` básico com suas principais preferências
2. **Itere e melhore**: Atualize o `replit.md` enquanto trabalha com o Agent
3. **Compartilhe padrões**: Use configurações bem-sucedidas de `replit.md` em projetos similares
4. **Monitore a eficácia**: Preste atenção em quão bem o Agent segue suas diretrizes e ajuste conforme necessário

Saiba mais sobre [como trabalhar com o Agent](/pt/references/agent/overview) ou explore outras [ferramentas de IA](/pt/build/welcome).

**Enterprise**: Pré-configure o `replit.md` em [templates personalizados](/pt/teams/custom-templates) para dar a todos os construtores da sua organização um contexto inicial consistente. Para orientação específica de design, consulte [como configurar um design system](/pt/teams/custom-design-system).
