mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
91 lines
3.5 KiB
Markdown
91 lines
3.5 KiB
Markdown
DOXA-CLI
|
|
|
|
DOXA-CLI is a command-line tool for managing your notes. It allows you to add, view, edit, delete, export notes, as well as filter and search them. The application is written in Go and offers a modern Terminal User Interface (TUI).
|
|
|
|
<p align="center">
|
|
<img src="https://img.shields.io/badge/go-1.22+-00ADD8?style=flat-square&logo=go&logoColor=white" alt="Go 1.22+">
|
|
<img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT license">
|
|
<img src="https://img.shields.io/badge/tested-Linux-brightgreen?style=flat-square" alt="Tested on Linux">
|
|
</p>
|
|
<p align="center">
|
|
<img src="https://img.shields.io/badge/freebsd-AB2B28?style=for-the-badge&logo=freebsd&logoColor=white" alt="freeBSD">
|
|
</p>
|
|
|
|
## Prerequisites
|
|
|
|
Before installing DOXA-CLI, it is assumed that you have **Go installed on your system. The recommended version is 1.20 or higher.
|
|
You can download Go from the official website: [https://go.dev/doc/install](https://go.dev/doc/install)
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
To install DOXA-CLI on your system, follow these steps:
|
|
|
|
1. **Clone the repository**:
|
|
Get the latest version of the code from Git:
|
|
``` bash
|
|
git clone https://codeberg.org/Kankys/doxa-cli.git
|
|
cd doxa-cli # Go to the project directory
|
|
```
|
|
|
|
2. **Run the installation script**:
|
|
``` bash
|
|
chmod +x install.sh
|
|
./install.sh
|
|
```
|
|
The installation script will do the following:
|
|
* Check if you have Go installed.
|
|
* Download all necessary Go modules and project dependencies.
|
|
* Compile the application for your operating system.
|
|
* Install the `doxa-cli` executable file in the `$HOME/.local/bin/` directory.
|
|
* Creates the `~/doxa-cli` configuration directory and the `doxa_notes.json` file if they do not exist.
|
|
|
|
3. **Add to PATH (if necessary)**:
|
|
After successful installation, you should be able to run `doxa-cli` from another location in the terminal. If the `doxa-cli` command is not recognized, it is assumed that the `$HOME/.local/bin` directory is not in your `PATH` system variable.
|
|
|
|
You can fix this by adding the following line to your shell profile (e.g. `~/.bashrc` for Bash, `~/.zshrc` for Zsh, or `~/.profile` for other systems):
|
|
``` bash
|
|
export PATH=$PATH:$HOME/.local/bin
|
|
```
|
|
After editing the profile file, **restart the terminal** or load the profile (e.g. `source ~/.bashrc`).
|
|
|
|
## Post-installation cleanup
|
|
|
|
Once the installation is successfully completed, the source files in the project directory are no longer needed. You can delete the entire folder with the cloned repository:
|
|
|
|
``` bash
|
|
rm -rf doxa-cli
|
|
```
|
|
|
|
## Usage
|
|
|
|
After successful installation, you can run the application from another directory by typing:
|
|
``` bash
|
|
doxa-cli
|
|
```
|
|
For detailed control in the TUI interface, follow the help displayed directly in the application.
|
|
|
|
## Backup
|
|
|
|
To backup your notes, you must save the `doxa_notes.json` file from the `~/.doxa-cli` configuration directory anywhere in your backup directory.
|
|
|
|
**Note**: The `doxa_notes.json` file contains all your notes and it is important to save it regularly.
|
|
|
|
## Uninstall
|
|
|
|
To uninstall DOXA-CLI, follow these steps:
|
|
|
|
1. **Remove the executable**:
|
|
Remove the binary from your PATH:
|
|
``` bash
|
|
rm ~/.local/bin/doxa-cli
|
|
```
|
|
*(If you installed the binary in a different directory, use its path.)*
|
|
|
|
2. **Remove the configuration directory (optional)**:
|
|
If you want to remove all application data and configuration, the configuration directory:
|
|
``` bash
|
|
rm -rf ~/.doxa-cli
|
|
```
|
|
**WARNING**: This step will delete ALL your notes. If you want to keep your data, skip this step. |