Comandos

Para funcionamento dos comandos é necessária a instalação do Tray CLI.

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.

help

Mostra uma listagem de todos os comandos disponíveis, bem como uma descrição sucinta sobre o comando.

Terminal

tray help [command]

Se o parâmetro command for passado mostra a ajuda específica do comando solicitado.

configure

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:

• key
• password
• theme_id

Terminal

tray configure [options] [key] [password] [theme_id]

Caso não passe os parâmetros acima o programa irá solicitá-los interativamente.

Parâmetros disponíveis para [options]	Descrição
--debug	Ao utilizá-la serão gerados arquivos de log "que começam com . e são ignorados pelo programa" na pasta raiz onde o comando é executado.

list

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".​

Terminal

tray list

create

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:

• key
• password
• theme-name
• theme-base

Terminal

tray create [options] [key] [password] [theme-name] [theme-base]

Se algum parâmetro não for informado, o programa irá solicitá-lo.

Parâmetros disponíveis para [options]	Descrição
--debug	Ao utilizá-la serão gerados arquivos de log "que começam com . e são ignorados pelo programa" na pasta raiz onde o comando é executado.

clean-cache

Limpa o cache de um tema.

Para localizar as informações necessárias para o comando na plataforma, acesse o link:

• theme_id

Terminal

tray clean-cache [theme-id]

Se o parâmetro opcional theme-id não for fornecido, o programa usará o tema configurado no arquivo config.yml.

delete

Deleta um tema específico da loja.

Para localizar as informações necessárias para o comando na plataforma, acesse o link:

• theme_id

Terminal

tray delete [theme-id]

Se o parâmetro opcional theme-id não for fornecido, o programa usará o tema configurado no arquivo config.yml.

download

Baixa os arquivos especificados do tema configurado.

tray download [files...]

Se o parâmetro opcional files não for fornecido, o programa irá baixar todos os arquivos do tema.

upload

Envia os arquivos para a loja no tema configurado.

tray upload [options] [files...]

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
--core	Indica ao programa para enviar somente os arquivos essenciais, ignorando os arquivos settings.json e a pasta img por completo.

Esse comando suporta padrões Glob e usa a biblioteca node-glob para isso.

remove

Remove os arquivos especificados do tema configurado. É obrigatório passar os arquivos que deseja remover.

tray remove <files...>

Esse comando suporta padrões Glob e usa a biblioteca node-glob para isso.

watch

Monitora os arquivos para verificar se ocorreram mudanças e automaticamente realiza as devidas alterações na loja.

tray watch

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.

open

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.

tray open

Identifique os Parâmetros

Abaixo estão listados os parâmetros necessários no uso dos comandos do Tray CLI e como encontrá-los na plataforma Tray.

key

Nú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.

password

Nú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_id

Número do código do tema exibido na lista de temas da plataforma.

theme-name

Nome do tema que é exibido na lista de temas da plataforma.

theme-base

Aviso

Este parâmetro está atualmente obsoleto e não deve ser utilizado.