doxa/doxa-cli/README_CZ.md

DOXA-CLI

DOXA-CLI je nástroj pro správu vašich poznámek z příkazové řádky. Umožňuje přidávat, zobrazovat, upravovat, mazat, exportovat poznámky a také je filtrovat a vyhledávat. Aplikace je napsána v Go a nabízí moderní terminálové uživatelské rozhraní (TUI).

Předpoklady

Před instalací DOXA-CLI se ujistěte, že máte na svém systému nainstalovaný Go. Doporučená verze je 1.20 nebo vyšší. Stáhnout Go můžete z oficiálního webu: https://go.dev/doc/install

Instalace

Pro instalaci DOXA-CLI na váš systém postupujte podle následujících kroků:

1. Naklonujte repozitář: Získejte nejnovější verzi kódu z Gitea:

   git clone https://codeberg.org/Kankys/doxa-cli.git
   cd doxa-cli # Přejděte do adresáře projektu
   

2. Spusťte instalační skript:

   chmod +x install.sh
   ./install.sh
   

   Instalační skript provede následující:

   • Zkontroluje, zda máte nainstalované Go.
   • Stáhne všechny potřebné Go moduly a závislosti projektu.
   • Zkompiluje aplikaci pro váš operační systém.
   • Nainstaluje spustitelný soubor doxa-cli do adresáře $HOME/.local/bin/.
   • Vytvoří konfigurační adresář ~/.doxa-cli a soubor doxa_notes.json, pokud neexistují.

3. Přidání do PATH (pokud je nutné): Po úspěšné instalaci byste měli být schopni spustit doxa-cli z jakéhokoli místa v terminálu. Pokud příkaz doxa-cli není rozpoznán, je pravděpodobné, že adresář $HOME/.local/bin není ve vaší systémové proměnné PATH.

   Můžete to opravit přidáním následujícího řádku do vašeho shell profilu (např. ~/.bashrc pro Bash, ~/.zshrc pro Zsh, nebo ~/.profile pro jiné systémy):

   export PATH=$PATH:$HOME/.local/bin
   

   Po úpravě souboru profilu restartujte terminál nebo načtěte profil (např. source ~/.bashrc).

Úklid po instalaci

Jakmile je instalace úspěšně dokončena, zdrojové soubory v adresáři projektu již nejsou potřeba. Celou složku s klonovaným repozitářem můžete smazat:

rm -rf doxa-cli

Použití

Po úspěšné instalaci můžete aplikaci spustit z jakéhokoliv adresáře zadáním:

doxa-cli

Pro detailní ovládání v TUI rozhraní se řiďte nápovědou zobrazovanou přímo v aplikaci.

Záloha

Pro zálohu vašich poznámek je nutné si uložit soubor doxa_notes.json z konfiguračního adresáře ~/.doxa-cli kamkoliv do vašeho záložního adresáře.

Poznámka: Soubor doxa_notes.json obsahuje všechny vaše poznámky a je důležité si jej pravidelně uložit.

Odinstalace

Pro odinstalaci DOXA-CLI postupujte takto:

1. Odstraňte spustitelný soubor: Odstraňte binárku aplikace z vašeho PATH:

   rm ~/.local/bin/doxa-cli
   

   (Pokud jste binárku nainstalovali do jiného adresáře, použijte jeho cestu.)

2. Odstraňte konfigurační adresář (volitelné): Pokud chcete odstranit i veškerá data a konfiguraci aplikace, odstraňte konfigurační adresář:

   rm -rf ~/.doxa-cli
   

   UPOZORNĚNÍ: Tento krok smaže VŠECHNY vaše poznámky. Pokud si chcete data ponechat, tento krok vynechejte.