Index é um organizador de artigos e documentos PDF elegante para o terminal. Ele utiliza uma interface TUI (Text User Interface) moderna para ajudar você a manter sua biblioteca limpa, categorizada e acessível.
- 📂 Organização Automática: Detecta metadados (Status, Origem, Autor, Título) diretamente do nome do arquivo.
- 🛠️ Edição Rápida: Modifique metadados e renomeie arquivos fisicamente no disco sem sair do terminal.
- 🔍 Filtro Inteligente: Separação automática entre artigos validados e arquivos "Uncategorized".
- 🚀 Navegação Turbo: Auto-complete de caminhos com
TABe preview visual de diretórios. - 🗑️ Segurança: Integração com a lixeira do sistema (
send2trash) para evitar perdas acidentais.
O Index é construído com uv. Para instalar o comando index globalmente em sua máquina:
# Clone o repositório
git clone https://github.com/seu-usuario/index.git
cd index
# Instale como uma ferramenta global
uv tool install .| Tecla | Ação |
|---|---|
Enter |
Abre o PDF no visualizador padrão do sistema |
E |
Edita os metadados do artigo (Status, Autor, etc) |
Del |
Move o arquivo para a lixeira (com confirmação) |
S |
Configura o diretório alvo da biblioteca |
R |
Atualiza a listagem de arquivos |
Q |
Sai do aplicativo |
Se você deseja contribuir para o projeto:
- Faça o setup do ambiente de desenvolvimento:
uv sync --all-groups
- Rode os testes para garantir a integridade:
uv run pytest --cov=index_tui
- Crie uma branch para sua funcionalidade e abra um Pull Request.
Nota: O Index é um projeto de verdade, mas também é um experimento de codificação agêntica.