Pular para o conteúdo
OSX-REIMS
Documentação: Comandos

Documentação · Uso

Comandos

Referência de todos os comandos do osx-reims e das suas opções.

Alfa

Esta documentação corresponde ao OSX-REIMS 0.3.0, em estágio alfa. Comandos e opções podem mudar entre versões; na dúvida, confira osx-reims --help na versão instalada.

Sem comando, osx-reims abre o console. Tudo o que o menu faz também existe como comando, para quem prefere o terminal ou quer automatizar.

osx-reims [comando] [opções]

Resumo

Comando O que faz
setup Prepara o computador: pacotes, KVM, acesso à GPU, Rust e Reims vGPU
doctor Confere se o computador está pronto, sem mudar nada
update-reims Atualiza o Reims vGPU para a versão testada ou a mais recente e o compila
create Cria uma VM pronta para instalar o macOS
import Cria uma VM a partir do disco QCOW2 de um macOS já instalado em outra VM
list Lista as VMs, o estado de cada uma e as que estão rodando
start [VM] Inicia a VM; sem número, pergunta qual
stop [VM] Pede ao macOS para desligar e espera
reset [VM] Reinicia a VM à força
poweroff [VM] Desliga a VM à força, como tirar da tomada (também quit)
term [VM] Encerra o processo da VM, quando ela não responde
delete [VM] Apaga uma VM desligada
delete --all Apaga todas as VMs, que precisam estar desligadas
clean-cache [versão] Apaga os instaladores do macOS baixados (--all: todos)
help Mostra a ajuda
version, --version Mostra a versão do OSX-REIMS

Cada comando tem a própria ajuda: osx-reims <comando> --help.

Opções comuns

Opção O que faz
-y, --yes Não faz perguntas: usa os valores das opções ou os padrões
--debug Inclui o rastreamento do bash (set -x) no log
-h, --help Mostra a ajuda do comando

Onde aparece [VM], use o número da VM (por exemplo, 13) ou o nome da pasta dela (macos-13). A opção -i <n> também funciona.

Cada ação grava um log em /opt/osx-reims/logs/, com a ação, a data e a hora no nome do arquivo. O mais recente também fica em latest.log.

Preparação do computador

setup

osx-reims setup [opções]

Prepara o computador: pacotes do sistema, acesso à GPU, KVM, Rust e o Reims vGPU, baixado em /opt/reims-vgpu e compilado. Rode com o seu usuário normal, sem sudo: a senha de administrador só é pedida nas etapas que precisam dela. Pode ser executado de novo, porque etapas já concluídas são puladas. Veja Instalação.

Opção O que faz
--tested Segue o commit testado do Reims vGPU (padrão)
--latest Segue o commit mais recente do Reims vGPU, não testado
--reims-ref <ref> Usa um commit, tag ou branch do Reims vGPU (avançado, não testado)
--accept-license Aceita a licença sem perguntar (obrigatório com -y)
--rebuild Compila o Reims vGPU de novo, mesmo que já esteja atualizado
--skip-build Para antes da compilação (para testes)
-y, --yes Não pergunta nada; o sudo ainda pode pedir a senha

doctor

osx-reims doctor [opções]

Confere se o computador está pronto e mostra o que está errado e como corrigir. Não muda nada e não pede senha. O log dele não tem números de série nem outros dados de identidade das VMs e é o que deve ser compartilhado ao pedir ajuda. Veja Solução de problemas.

Opção O que faz
--online Também testa a conexão com o GitHub e com os servidores do Rust

Código de saída: 0 quando nenhuma verificação falhou (avisos são permitidos) e 1 quando alguma falhou.

update-reims

osx-reims update-reims [opções]

Atualiza o Reims vGPU em /opt/reims-vgpu e o compila de novo, seguindo a versão escolhida. Sem --tested ou --latest, pergunta qual seguir, oferecendo a escolha atual. Todas as VMs precisam estar desligadas. Se o novo commit não compilar ou não passar nas verificações, o commit anterior volta e é compilado de novo. Veja Versão do Reims vGPU.

Opção O que faz
--tested Vai para o commit testado e passa a segui-lo
--latest Vai para o commit mais recente do master e passa a segui-lo (não testado)
--reims-ref <ref> Usa um commit, tag ou branch do Reims vGPU (avançado, não testado)
-y, --yes Não pergunta: mantém a escolha atual, a menos que uma opção a mude

VMs

create

osx-reims create [opções]

Cria uma VM com disco vazio, OpenCore e o instalador do macOS: o Recovery, baixado da Apple (a instalação usa a internet), ou uma imagem de instalador completo. Sem opções, pergunta os valores. Cada VM recebe número de série, MLB, UUID, ROM e endereço MAC próprios. Veja Primeira VM.

Opção O que faz
-i, --id <n> Número da VM, de 10 a 99 (padrão: o primeiro livre)
-m, --macos <nome> ventura, sonoma, sequoia ou tahoe (padrão: ventura; com --installer, a versão da imagem)
-s, --disk-size <n> Tamanho do disco do macOS, como 256G ou 1T (padrão: 256G)
--installer <imagem> Usa uma imagem de instalador completo em vez do Recovery
--redownload Baixa o Recovery de novo, mesmo que já esteja em cache

Exemplo sem perguntas:

osx-reims create -i 11 -m sonoma -s 256G -y

import

osx-reims import [opções]

Cria uma VM a partir do disco QCOW2 de um macOS já instalado em outra VM, como no OSX-PROXMOX, com disco de inicialização próprio. O disco é copiado para a pasta da VM: o arquivo original não é alterado e pode ser apagado depois. A VM recebe identidade nova. Sem opções, pergunta os valores. Veja Importar uma VM.

Opção O que faz
-i, --id <n> Número da VM, de 10 a 99 (padrão: o primeiro livre)
-d, --disk <arquivo> Disco QCOW2 a importar
-m, --macos <nome> ventura, sonoma, sequoia, tahoe ou other: a versão mostrada na lista de VMs
-y, --yes Não pergunta nada (exige --disk)

Exemplo:

osx-reims import -d ~/Downloads/macos.qcow2 -m tahoe

list

osx-reims list

Lista as VMs, o estado de cada uma e as que estão rodando. Os estados são explicados em Primeira VM.

start

osx-reims start [VM] [opções]

Inicia a VM. Sem número, pergunta qual; se a escolhida já estiver rodando, pergunta o que fazer com ela. Na primeira inicialização de uma VM criada com instalador, abre a instalação do macOS.

Opção O que faz
-r, --ram <n> Memória, como 8G ou 16384M (padrão: 8G)
-c, --cpus <n> Processadores, de 1 a 32 (padrão: 4)
--opencore <s> Qual OpenCore inicia a VM: image ou esp (padrão: a escolha salva da VM, senão image)
-n, --dry-run Mostra o comando de inicialização e sai, sem iniciar a VM
-y, --yes Não pergunta; sem número, usa a VM atual, normalmente a última criada

Com a VM aberta pelo start, o terminal aceita teclas, sempre pressionadas duas vezes em até 5 segundos:

Tecla O que faz
S Pede ao macOS para desligar
R Reinicia a VM à força
F Desliga a VM à força
T Encerra o processo da VM

Pressionar Ctrl+C duas vezes também pede ao macOS para desligar. Fechar o terminal não desliga a VM.

stop, reset, poweroff e term

osx-reims stop [VM] [opções]
osx-reims reset [VM] [opções]
osx-reims poweroff [VM] [opções]
osx-reims term [VM] [opções]
  • stop pede ao macOS para desligar e espera. Se o macOS não desligar a tempo, pergunta se deve esperar mais, forçar o desligamento ou cancelar.
  • reset reinicia a VM à força.
  • poweroff, ou quit, desliga a VM à força, como tirar da tomada.
  • term encerra o processo da VM, para quando ela não responde.

Atenção

Para o macOS, reset, poweroff e term equivalem a um corte de energia: o que não foi salvo se perde. O disco da VM continua íntegro nos três casos.

Sem número e com uma única VM rodando, esses comandos agem sobre ela.

Opção O que faz
--wait <s> stop: segundos de espera pelo macOS (padrão: 60)
--pid <n> Age sobre o processo do QEMU com esse PID (obrigatório para VMs fora da pasta de VMs)
-y, --yes Não pede confirmação

delete

osx-reims delete [VM] [opções]
osx-reims delete --all [opções]

Apaga a pasta inteira da VM, com os discos. Sem número, pergunta qual. A VM precisa estar desligada; com --all, todas precisam estar, senão nenhuma é apagada. O cache de instaladores não é tocado.

Cuidado

Apagar uma VM não pode ser desfeito: o macOS instalado e todos os arquivos dentro dele são apagados.

Opção O que faz
--all Apaga todas as VMs
-y, --yes Não pede confirmação

Instaladores

clean-cache

osx-reims clean-cache [versão|--all] [opções]

Apaga os instaladores do macOS guardados em /opt/osx-reims/cache/: o Recovery de cada versão e downloads interrompidos. VMs já criadas não são afetadas, porque cada uma tem a própria cópia do instalador. A próxima criação com uma versão apagada baixa o instalador de novo. Sem versão nem --all, lista o cache e pergunta.

A versão é ventura, sonoma, sequoia ou tahoe.

Opção O que faz
--all Apaga o cache inteiro
-y, --yes Não pede confirmação

Variáveis de ambiente

As variáveis REIMS_ROOT, RAILS_DIR, MACRECOVERY, QMP_TIMEOUT e NO_COLOR e o arquivo /etc/osx-reims.conf estão em Configuração avançada.