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.
O Agent cria automaticamente esse arquivo no diretório raiz do seu projeto usando as melhores práticas comprovadas. O Agent inclui seu conteúdo no contexto para ajudá-lo a entender suas preferências, a estrutura do projeto e o estilo de programação.
Como o replit.md funciona
O Agent primeiro cria um arquivo replit.md no diretório raiz do seu projeto usando as melhores práticas comprovadas. Esse arquivo inclui:
- Informações básicas do projeto
- Padrões de programação recomendados
- Preferências comuns para o tipo de projeto
Quando o Agent processa suas solicitações, ele lê automaticamente o arquivo replit.md e usa seu conteúdo para:
- Compreender a arquitetura e as convenções do seu projeto
- Seguir seus padrões e estilo de programação preferidos
- Usar os gerenciadores de pacotes e dependências que você especificou
O Agent também pode atualizar o arquivo replit.md à medida que aprende mais sobre o projeto e faz alterações no seu aplicativo.
Você pode editar o arquivo replit.md para personalizar o comportamento do Agent.
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 as melhores práticas comprovadas. Esse arquivo aparece no diretório raiz do seu projeto e inclui:
- Informações básicas do projeto
- Padrões de programação recomendados
- Preferências comuns para o tipo de 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 projeto. O Agent detectará e usará automaticamente esse arquivo em conversas futuras.
O replit.md deve estar localizado no diretório raiz do projeto para funcionar corretamente.
Regenerando o replit.md
Se o seu arquivo replit.md ficar corrompido ou você quiser começar do zero:
- Exclua o arquivo
replit.md existente da raiz do projeto
- Inicie uma nova conversa com o Agent
- O Agent gerará automaticamente um novo arquivo
replit.md com base no seu projeto atual
Melhores práticas
Seja específico e claro
Escreva instruções claras e específicas que ajudem o Agent a entender exatamente o que você quer:
## Estilo de Programação
- Use TypeScript para todos os novos arquivos JavaScript
- Prefira componentes funcionais com hooks em vez de componentes de classe
- Use Tailwind CSS para estilização, evite estilos inline
- Sempre inclua tipos TypeScript para parâmetros de funções e valores de retorno
Para um guia mais detalhado sobre formatação de prompts, consulte o guia de engenharia de prompts da Anthropic.
Use exemplos
Exemplos ajudam o Agent a entender suas preferências melhor do que descrições abstratas:
## Tratamento de Erros de API
Ao criar endpoints de API, sempre use este padrão de tratamento de erros:
```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:
## Estilo de Comunicação
- Antes de implementar mudanças, explique o que você vai fazer e por quê
- Divida tarefas complexas em etapas claras
- Peça esclarecimentos se os requisitos não estiverem claros
- Forneça breves explicações para decisões técnicas
Especifique o contexto do projeto
Ajude o Agent a entender o propósito e as restrições do seu projeto:
## Contexto do Projeto
Este é um aplicativo de mídia social para amantes de livros onde os usuários podem:
- Criar listas de leitura e compartilhar recomendações de livros
- Seguir outros leitores e ver suas atualizações
- Avaliar e fazer resenhas de livros que leram
Público-alvo: Leitores casuais de 25 a 45 anos
Stack tecnológico: Frontend em React, backend em Node.js, banco de dados PostgreSQL
Exemplos de configurações do replit.md
Projeto de aplicativo web
# Diretrizes do Projeto MyApp
## Visão Geral do Projeto
Um aplicativo web de gerenciamento de tarefas construído com React e Express.js.
## Preferências de Tecnologia
- Frontend: React com TypeScript, Tailwind CSS
- Backend: Express.js com TypeScript
- Banco de dados: Neon PostgreSQL com Drizzle ORM
- Gerenciador de pacotes: npm (não yarn ou pnpm)
## Padrões de Programação
- Use componentes funcionais com hooks
- Implemente limites de erro adequados
- Siga as convenções de API REST para endpoints
- Use nomes descritivos para variáveis e funções
## Estilo de Comunicação
- Explique sua abordagem antes de fazer alterações
- Forneça comentários no código para lógica complexa
- Faça perguntas se os requisitos forem ambíguos
Projeto de análise de dados
# Diretrizes do Projeto de Análise de Dados
## Contexto do Projeto
Análise de dados de comportamento de clientes para identificar tendências e insights.
## Preferências de Tecnologia
- Python com Streamlit para aplicativos web interativos
- pandas, numpy e matplotlib para análise de dados
## Padrões de Análise
- Inclua documentação clara para todas as etapas de análise
- Crie visualizações interativas com componentes Streamlit
- Valide a qualidade dos dados antes da análise
- Exporte os resultados para o formato CSV e exiba em tabelas Streamlit
## Estilo de Comunicação
- Explique métodos e suposições estatísticas
- Forneça contexto para descobertas e recomendações
- Use linguagem clara e não técnica para insights de negócios
- Crie dashboards interativos para apresentações a stakeholders
Projeto de desenvolvimento de API
# Diretrizes de Desenvolvimento de API
## Visão Geral do Projeto
Construindo uma API RESTful para um backend de aplicativo móvel.
## Stack Tecnológico
- Node.js com Express.js
- MongoDB com Mongoose
- JWT para autenticação
- Gerenciador de pacotes: npm
## Padrões de API
- Use códigos de status HTTP semânticos
- Implemente validação adequada de entrada
- Inclua limitação de taxa em endpoints públicos
- Siga a especificação OpenAPI para documentação
## Requisitos de Segurança
- Valide todas as entradas do usuário
- Use variáveis de ambiente para dados sensíveis
- Implemente políticas CORS adequadas
- Inclua registro de requisições para depuração
## Abordagem de Testes
- Escreva testes unitários para todos os endpoints
- Inclua testes de integração para fluxos críticos
- Use Jest como framework de testes
Uso avançado
Orientação dinâmica do projeto
Atualize o arquivo replit.md à medida que o projeto evolui para fornecer contexto atual:
## Fase de Desenvolvimento Atual
A equipe está focada atualmente na implementação da autenticação de usuários.
Recursos prioritários:
1. Registro e login de usuários
2. Funcionalidade de redefinição de senha
3. Verificação de e-mail
## Decisões Recentes
- Mudamos da autenticação local para OAuth com Google
- Adicionamos Redux para gerenciamento de estado
- Decidimos usar Material-UI para estilização consistente
Referencie documentação e ferramentas externas no seu replit.md:
## Recursos Externos
- Sistema de design: Siga o sistema de design Figma em [link]
- Documentação de API: Consulte os docs internos da API
- Padrões de programação: Siga o guia de estilo da equipe em nosso wiki
## Processo de Implantação
- Teste as alterações no ambiente de desenvolvimento primeiro
- Use o pipeline de CI/CD para apps publicados em staging
- Exija revisão de código antes das versões em produção
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 conhecimento atualizado e orientações específicas do projeto.
Melhores práticas para integração de pesquisa na web
Seja específico sobre o que você quer que o Agent pesquise:
## Preferências de Pesquisa
- Sempre verifique as versões mais recentes das dependências antes de sugerir atualizações
- Pesquise as melhores práticas atuais para implementações de segurança
- Busque técnicas recentes de otimização de desempenho para nossa stack
Oriente o Agent sobre como aplicar o conhecimento externo:
## Diretrizes de Pesquisa Externa
- Ao sugerir novas bibliotecas, garanta compatibilidade com nossa stack existente
- Adapte exemplos externos para corresponder aos nossos padrões de programação e estrutura do projeto
- Verifique se as soluções sugeridas funcionam com nosso ambiente de publicação
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”
Essa 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 um limite estrito de caracteres para o replit.md, arquivos muito grandes podem não ser totalmente processados. Mantenha o replit.md focado e conciso para melhores resultados.
Requisito de diretório raiz
O replit.md deve existir no diretório raiz do projeto. O Agent não detectará automaticamente arquivos em subdiretórios.
Escopo do contexto
O replit.md fornece contexto para as conversas do Agent, mas não se aplica automaticamente a outras ferramentas de IA.
Próximos passos
Pronto para personalizar o Agent para o seu projeto?
- Comece de forma simples: Crie um
replit.md básico com suas principais preferências
- Itere e melhore: Atualize o
replit.md enquanto trabalha com o Agent
- Compartilhe padrões: Use configurações bem-sucedidas de
replit.md em projetos similares
- Monitore a eficácia: Preste atenção em como o Agent segue suas diretrizes e ajuste conforme necessário
Saiba mais sobre como trabalhar com o Agent ou explore outras ferramentas de IA.
Enterprise: Pré-configure o replit.md em templates personalizados para dar a todos os desenvolvedores da sua organização um contexto inicial consistente. Para orientações específicas de design, veja como configurar um sistema de design.