Interface de linha de comando desenvolvida em Node.js e TypeScript para ajudar desenvolvedores a criarem ótimos temas para Tray.
Atenção Esse programa está em fase de desenvolvimento e portanto não garantimos o correto funcionamento. Ajude-nos reportando problemas ao utilizá-lo.
- Instalação
- Roadmap
- Comandos disponíveis
- tray help [command]
- tray configure [key] [password] [theme_id]
- tray themes
- tray new <key> <password> <theme_name> [theme_base]
- tray clean-cache [theme_base]
- tray delete-theme <theme_id>
- tray download [files...]
- tray upload [files...]
- tray delete-file <files...>
- tray rm <files...>
- tray watch
- tray open
- Contribuidores
- Créditos
- Licença
Para usar esse programa basta instalar com os comandos abaixo. Recomendados fazer a instalação global.
# Instala globalmente no sistema (Recomendado)
npm install tray-theme --global
# Instala na pasta local
npm install tray-theme
Se desejar não fazer a instalação global, todos os comando abaixo precisaram ter acrescido npx
antes para que ele seja executado da instalação local.
Acompanhe a evolução do projeto através das issues e das milestones definidas nessa página.
Os comandos abaixo estão disponíveis no programa. Todos eles se iniciam pela palavra tray
. Parâmetros obrigatórios são indicados entre maior/menor (<>) e parâmetros opcionais entre colchetes ([]).
Mostra a mensagem de ajuda e todos os commandos disponíveis. Se o parâmetro command
for passado mostra a ajuda apenas para aquele comando.
Cria o arquivo de configuração. Caso não passe os parâmetros acima o programa irá pedí-los.
Lista todos os temas disponíveis. Os temas serão exibidos em formato de tabela.
Atenção: o opencode online não remove os temas, apenas os marca como removido. Por isso esse irá exibir todos os temas, mesmo que eles não apareçam mais no site.
Cria um novo tema na plataforma.
key
- Chave de autorizaçào ao opencodepassword
- Senha de autorizaçào ao opencodetheme_name
- Nome que deseja dar ao tematheme_base
- Tema no qual o novo tema será baseado.
Limpa os caches de um tema. Se o parâmetro theme_base
não for informado, o programa limpará o cache do tema configurado, caso contrário do tema informado.
Delete o tema informado. Esse comando precisa de confirmação para ser executado. Por padrão ao dar o Enter ao ser perguntado o comando será abortado. Precise Y para confirmar a exclusão. Atenção! essa operação não poderá ser desfeita.
Baixa os arquivos do tema. O parâmetro files
pode receber vários arquivos, basta separá-los com espaço. Se nenhum arquivo for específicado todos os arquivos do tema são baixados.
# Baixa todos os arquivos do tema
tray download
# Baixa somente os arquivos footer.html e header.html da pasta elements
tray download elements/footer.html elements/header.html
Envia os arquivos do tema para os servidores da Tray. O parâmetro files
pode receber vários arquivos, basta separá-los com espaço. Se nenhum arquivo for específicado todos os arquivos do tema são enviados.
# Envia todos os arquivos do tema
tray upload
# Envia somente os arquivos footer.html e header.html da pasta elements
tray upload elements/footer.html elements/header.html
Delete os arquivos solicitados dos servidores da Tray. O parâmetro files
pode receber um ou vários arquivos, basta separá-los com espaço.
Alias para tray delete-file <files...>
Observa a pasta atual do projeto para identificar mudanças nos arquivos e envia-los aos servidores da Tray. Suporta o envio ao colar novos arquivos na pasta do projeto, sem a necessidade de modificá-los.
Apesar do programa suportar todas as operações que o sistema permite, nem todas são suportadas pela API da Tray. Veja abaixo quais operações são permitidas:
Suportado
- Criação de arquivos
- Remoção de arquivos
- Modificação de arquivos
Não suportados
- Criação de pastas vazias
- Remoção de pastas
Abre a url de preview do tema no navegador padrão.
Esse projeto foi criado a partir do desejo da comunidade de desenvolvedores da Tray por um CLI mais atualizado e responsivo. Obrigado a todos que contribuem com o desenvolvimento do projeto, seja reportando problemas, melhorias ou enviando códigos 🙂🎉.
Agradecimento especial a Netzee - Agência de E-commerce por fornecer acesso a plataforma Tray e ter permitido o surgimento desse projeto.
Criado por Rafael Andrade.