Harumi

Começando um projeto

Três formas de colocar código na Harumi — escolha a que combina com o que você já tem.

Qual é a sua jornada?

Todo projeto Harumi é um repositório git mais um harumi.toml que diz o que executar. Como chegar lá depende do que você já tem:

Usando a CLI? O harumi start faz essa mesma pergunta de forma interativa e executa o comando certo para você — tudo abaixo é o que ele faz por baixo dos panos.

1. Nada ainda

Você não tem código nem projeto. A Harumi cria o projeto, provisiona seu repositório git e o preenche com um scaffold executável (harumi.toml, main.py, dashboard/overview.toml) — assim já existe algo para executar imediatamente.

Crie o projeto

Na sua página de projetos, clique em New project e escolha o workspace (pessoal ou uma organização) ao qual ele pertence. Não sabe por onde começar? Clique em Descrever meu problema: conte o que você quer melhorar com as suas palavras e o assistente prepara o projeto e monta o checklist dele.

Execute

Abra a aba Código para ver o scaffold, depois clique em Run na barra de ferramentas. Veja os Primeiros Passos para entender o que cada arquivo do scaffold faz.

2. Uma pasta de código na sua máquina

Você já tem código — um script no qual você vem trabalhando, um repositório antigo do GitHub, o zip de um colega. A Harumi cria um novo projeto e então transforma o conteúdo da sua pasta no primeiro commit do repositório. Isso sobrescreve o scaffold gerado pelo servidor, então, se sua pasta não tiver um harumi.toml, um é escrito para você antes do push (com python main.py como palpite inicial — edite se seu ponto de entrada for diferente).

Comece um novo projeto a partir dos seus arquivos

Na sua página de projetos, clique em New project. No diálogo, abra Opções avançadas e solte um .zip da sua pasta em Start from a ZIP or folder (optional) ou selecione-o diretamente (upload de pasta também é suportado).

Crie o projeto

Clique em Create project. O projeto começa exatamente com os seus arquivos, no lugar dos arquivos padrão — um harumi.toml precisa estar entre os arquivos enviados, ou o harumi run vai falhar depois por falta de manifesto.

Por que isso faz force-push

O repositório recém-provisionado só tem o commit do scaffold — não há histórico em comum com sua pasta local para um push normal fazer merge. O force-push é a única forma de entrar; é seguro porque o repositório acabou de ser criado para isso.

3. Um projeto que já existe na Harumi

Alguém já criou o projeto — pelo aplicativo web, pela CLI, ou um colega — e você só precisa do código dele nesta máquina.

Abra a aba Código do projeto e copie a Clone URL no topo, depois:

git clone <CLONE_URL>

Isso traz o código, mas não um diretório reconhecido pela Harumi — você ainda vai precisar de harumi link --project <PROJECT_ID> (veja a aba CLI) para vinculá-lo e fazer o harumi run funcionar.

A pasta já está clonada?

Se você já tem o repositório clonado manualmente (por exemplo, via Clone URL do aplicativo web, ou moveu uma pasta que já estava vinculada), o harumi clone tentaria clonar em uma pasta existente e não vazia, e falharia. Use harumi link --project <PROJECT_ID> em vez disso — ele apenas grava .harumi/config.json e configura o remote git, sem tocar no seu checkout.

Próximos passos

On this page