Comandos
Para funcionamento dos comandos é necessária a instalação do Tray CLI.
Last updated
Para funcionamento dos comandos é necessária a instalação do Tray CLI.
Last updated
Os comandos abaixo estão disponíveis no programa através da linha de comando. Todos eles se iniciam pela palavra tray e os parâmetros obrigatórios são indicados entre maior/menor <> e parâmetros opcionais entre colchetes []. Parâmetros opcionais são independentes de ordem, ou seja, podem ser passados no início ou no final do comando.
Mostra uma listagem de todos os comandos disponíveis, bem como uma descrição sucinta sobre o comando.
Se o parâmetro command for passado mostra a ajuda específica do comando solicitado.
Cria o arquivo de configuração que conecta a pasta do tema no seu computador com a plataforma Tray.
Para localizar as informações necessárias para o comando na plataforma, acesse os links:
Caso não passe os parâmetros acima o programa irá solicitá-los interativamente.
| Parâmetros disponíveis para [options] | Descrição |
|---|---|
| Ao utilizá-la serão gerados arquivos de log "que começam com |
Lista todos os temas disponíveis atualmente na loja em formato de tabela, com o índice do tema, o id, o nome e um valor booleano que indica se o tema está publicado "1" ou não "0".
Cria um novo tema na loja com o nome passado e baseado no tema base.
Para localizar as informações necessárias para o comando na plataforma, acesse os links:
Se algum parâmetro não for informado, o programa irá solicitá-lo.
| Parâmetros disponíveis para [options] | Descrição |
|---|---|
| Ao utilizá-la serão gerados arquivos de log "que começam com |
Limpa o cache de um tema.
Para localizar as informações necessárias para o comando na plataforma, acesse o link:
Se o parâmetro opcional theme-id não for fornecido, o programa usará o tema configurado no arquivo config.yml.
Deleta um tema específico da loja.
Para localizar as informações necessárias para o comando na plataforma, acesse o link:
Se o parâmetro opcional theme-id não for fornecido, o programa usará o tema configurado no arquivo config.yml.
Baixa os arquivos especificados do tema configurado.
Se o parâmetro opcional files não for fornecido, o programa irá baixar todos os arquivos do tema.
Envia os arquivos para a loja no tema configurado.
Se o parâmetro opcional files não for fornecido, o programa irá enviar todos os arquivos, pastas e subpastas presentes na pasta raiz onde o comando é executado.
| Parâmetros disponíveis para [options] | Descrição |
|---|---|
| Indica ao programa para enviar somente os arquivos essenciais, ignorando os arquivos |
Esse comando suporta padrões Glob e usa a biblioteca node-glob para isso.
Remove os arquivos especificados do tema configurado. É obrigatório passar os arquivos que deseja remover.
Esse comando suporta padrões Glob e usa a biblioteca node-glob para isso.
Monitora os arquivos para verificar se ocorreram mudanças e automaticamente realiza as devidas alterações na loja.
Atenção
Nem todas as operações do sistema de arquivos do seu computador são suportadas pela API da Tray. Apenas as operações de criação, atualização, remoção e renomeação de arquivos são suportadas. Operações com pastas não são suportadas e serão ignoradas.
Observação
Arquivos SASS / SCSS não são mais suportados.
Abre no navegador padrão o link de prévia do tema. Útil para verificar se as modificações estão sendo aplicadas corretamente no tema.
Abaixo estão listados os parâmetros necessários no uso dos comandos do Tray CLI e como encontrá-los na plataforma Tray.
keyNúmero da Chave de autorização para uso do tray-cli na plataforma.
Para criar uma chave e senha é preciso acessar a plataforma Tray através do painel administrativo, acessando a aba Minha Loja > Design Da Loja > Lista de desenvolvedores ou Minha Loja > Aparência da Loja > Lista de desenvolvedores (de acordo com o painel da sua loja) depois clicar em "Incluir Desenvolvedor" inserir um nome e email, e clicar em "Salvar", dessa forma as chaves serão geradas automaticamente.
passwordNúmero da Senha de autorização para uso do tray-cli na plataforma.
Que deve ser a fornecida pela plataforma no mesmo processo de criação da key.
theme_idNúmero do código do tema exibido na lista de temas da plataforma.
theme-nameNome do tema que é exibido na lista de temas da plataforma.
theme-baseAviso
Este parâmetro está atualmente obsoleto e não deve ser utilizado.
