Skip to content

Latest commit

 

History

History
85 lines (66 loc) · 6.5 KB

README.md

File metadata and controls

85 lines (66 loc) · 6.5 KB
Raw

Projeto Nyx

GitHub License GitHub repo size GitHub Languages GitHub Version Project Codename Last Update GitHub Commits Issue Resolution Open Issues Pull Requests Contributors

O que é?

O Projeto Nyx é um plugin opcional desenvolvido em Shell Scripting para o Projeto Íris. Este plugin possibilita a implementação de todas as funcionalidades Bash, incluindo o uso de programas CLI, como os de hacking, APT ou similares (desde que a saida respeite o limite de caracteres de +- ~65K). Com isso, a Nyx elimina a necessidade de modificar o código principal da Íris ou de aprender Node.js (JavaScript) para realizar alterações.

Requisitos

Para garantir o correto funcionamento do Projeto Nyx, o Projeto Íris deve estar ativo. A versão atual do Projeto Nyx é beta e foi desenvolvida rapidamente para fins de aprendizado, podendo conter erros menores.

  1. Bash:
    • É recomendada a versão mais recente do Bash.
  2. Projeto Íris:
    • Deve estar instalada e em execução.
  3. Dependências do Projeto Íris:
    • Instale todas as dependências necessárias do Projeto Íris para assegurar o correto funcionamento da Nyx.
  4. Websocat:
  5. JQ:

Instale o 4 e 5 na path do sistema, assim Nyx conseguirá as usar para iniciar sem problemas. - Se não souber como inserir na path, procure por tutoriais ou use o tutorial do Projeto Íris para ter uma IDEIA BASE NO WINDOWS.

Execução

Após a instalação das dependências, você pode executar o Projeto Nyx de duas maneiras:

  1. Usando Bash:

    • Para executar o Projeto Nyx diretamente, utilize o seguinte comando:

      bash run.sh

    • Alternativamente:

    chmod +x run.sh
./run.sh

  2. Usando NPM:

    • Se preferir, você também pode iniciar a Nyx via NPM com o seguinte comando: 
      npm start
    • Isso executará o script bash diretamente através do NPM.

Modificação

Para modificar o Projeto Nyx, a maneira mais simples é através do sistema de cases que você encontrará na pasta src/Commands/Cases. Você encontrará exemplos de comandos que podem ser usados como base para criar novas funcionalidades.

Todos os parâmetros do Projeto Íris estão acessíveis via $(jq -r '.NomeDaVariavel' <<< "$env"), permitindo que você utilize as funcionalidades do Projeto Íris em seu código bash, mas esteja atento a sintaxe dele, que pode ser um pouco dificil para iniciantes.

Detalhes Adicionais

Informações da Versão:

  • Codinome: SNAIL
  • Versão: v1.0.0
  • Tipo: BETA
  • Erros: Nenhum bug grave detectado
  • Data de Lançamento: 08/09/2024
  • Observações: Esta versão pode apresentar problemas menores não graves devido à ausência de alguns parâmetros opcionais ainda não integrados no Projeto Íris. Atualizações futuras do Projeto Íris resolverão essas questões, garantindo a integração completa e o funcionamento adequado dos parâmetros. Não será necessário reinstalar a Nyx para aplicar essas atualizações, pois os parâmetros já estarão incorporados nas futuras versões da Íris, e nenhuma intervenção adicional será necessária no Projeto Nyx, a menos que haja novas atualizações da mesma.

Desenvolvimento Futuro

Mais novidades poderão chegar em breve! Fique atento às atualizações e acompanhe as redes sociais para mais informações!

Obrigado pelo seu interesse e apoio! Vamos continuar evoluindo juntos a um open-source melhor! ❤️