Skip to main content

Gerenciador de notas minimalista para terminal

Project description

🗒️ CLInote

📋 Sobre

O CLInote é um gerenciador de notas minimalista, focado em alta produtividade para quem vive no terminal. Desenvolvido para ser rápido, portátil e sem distrações, permitindo que você crie, liste e edite suas notas diretamente pelo seu editor favorito.

🚀 Funcionalidades

  • Terminal-First: Otimizado para um fluxo de trabalho CLI ágil.
  • Inteligente: Detecção automática do melhor editor disponível (Vim > Nano > Notepad).
  • Portátil: Funciona nativamente em Windows, Linux e macOS.
  • Leve: Sem dependências desnecessárias.

📦 Instalação

pip install CLInote

🛠️ Como usar

Após a instalação, o comando gr estará disponível globalmente:

Ação Comando Descrição
Criar nota gr add <nome> Cria uma nova nota e abre o editor.
Listar tudo gr list Exibe todas as suas notas salvas.
Abrir nota gr <nome> Abre uma nota existente para edição.
Deletar nota gr delete <id> Remove uma nota permanentemente.

💻 Configurando editores CLI (Recomendado)

Para a experiência completa no terminal, instale o Vim ou Nano:

  • Linux:
    • Ubuntu/Debian: sudo apt update && sudo apt install vim nano
    • Fedora: sudo dnf install vim nano
  • macOS: brew install vim nano
  • Windows: winget install vim.vim nano.nano

💡 Filosofia do Projeto

O CLInote acredita que a produtividade vem da simplicidade. O sistema buscará automaticamente o editor mais eficiente no seu ambiente. Caso nenhum editor CLI seja encontrado, o sistema utiliza o editor padrão do seu sistema operacional (Notepad).

💡 Dicas de Edição

O CLInote utiliza o editor do sistema. Aqui estão os comandos essenciais:

Vim:
Entrar no modo de inserção/editar: Pressione i.

Salvar e sair: ESC, digite :x e  Enter.

Copiar texto: Segure SHIFT enquanto seleciona com o mouse, depois use Ctrl + C.

------

Nano:
Salvar: Ctrl + O e Enter.

Sair: Ctrl + X.

Copiar: Selecione com o mouse e use Ctrl + Shift + C (ou apenas Enter em alguns terminais).

🗂️ Arquitetura de Dados

Os dados são armazenados localmente de forma persistente:

  • Windows: %APPDATA%\CLInote\
  • Linux/macOS: ~/.config/CLInote/

🛠 Tecnologias

  • Python 3: Linguagem principal do projeto.
  • JSON: Armazenamento leve e estruturado dos metadados.
  • Subprocess: Integração segura com editores de sistema.
  • Shutil: Detecção inteligente de dependências no PATH.

ENGLISH

📋 About

CLInote is a minimalist note manager focused on high productivity for terminal users. Built to be fast, portable, and distraction-free, it lets you create, list, and edit your notes directly from your favorite editor.

🚀 Features

  • Terminal-First: Optimized for an agile CLI workflow.
  • Smart: Automatic detection of the best available editor (Vim > Nano > Notepad).
  • Portable: Works natively on Windows, Linux, and macOS.
  • Lightweight: No unnecessary dependencies.

📦 Installation

pip install CLInote

🛠️ Usage

After installation, the gr command will be available globally:

Action Command Description
Create note gr add <name> Creates a new note and opens the editor.
List all gr list Displays all your saved notes.
Open note gr <name> Opens an existing note for editing.
Delete note gr delete <id> Permanently removes a note.

💻 Setting up CLI editors (Recommended)

For the full terminal experience, install Vim or Nano:

  • Linux:
    • Ubuntu/Debian: sudo apt update && sudo apt install vim nano
    • Fedora: sudo dnf install vim nano
  • macOS: brew install vim nano
  • Windows: winget install vim.vim nano.nano

💡 Project Philosophy

CLInote believes that productivity comes from simplicity. The system automatically looks for the most efficient editor in your environment. If no CLI editor is found, the system falls back to your operating system's default editor (Notepad).

💡 Editing Tips

CLInote uses your system editor. Here are the essential commands:

Vim:
Enter insert/edit mode: Press i.

Save and quit: ESC, type :x and press Enter.

Copy text: Hold SHIFT while selecting with the mouse, then use Ctrl + C.

------

Nano:
Save: Ctrl + O and Enter.

Quit: Ctrl + X.

Copy: Select with the mouse and use Ctrl + Shift + C (or just Enter on some terminals).

🗂️ Data Architecture

Data is stored locally and persistently:

  • Windows: %APPDATA%\CLInote\
  • Linux/macOS: ~/.config/CLInote/

🛠 Technologies

  • Python 3: Main project language.
  • JSON: Lightweight, structured metadata storage.
  • Subprocess: Safe integration with system editors.
  • Shutil: Smart dependency detection on PATH.

📄 License

MIT © Geovani Rodrigues 2026

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clinote-0.1.5.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clinote-0.1.5-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file clinote-0.1.5.tar.gz.

File metadata

  • Download URL: clinote-0.1.5.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for clinote-0.1.5.tar.gz
Algorithm Hash digest
SHA256 49dc891c8f5a17b582fc0fb30072a1e3a32e77678c18780c04a83bc32960d1bb
MD5 cef84781ebc571ca133eb4d4e2ced76a
BLAKE2b-256 6337822fc6ac5ddc853cd49599997b83bf6c327a370292d69f3d9dd9eaa309b2

See more details on using hashes here.

File details

Details for the file clinote-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: clinote-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for clinote-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 73211c16d5aa04b2d32b8bf78bcfe6a788f2668aad82660c12a9d1c269cf4e4a
MD5 aab6dc7b537721b1cddd315eb8468543
BLAKE2b-256 8a71d8dfb2c81924a4a72fcfd548679c801aaca48077c9db10edfeb62fc718c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page