1
0
Fork
You've already forked diskhub
0
No description
  • Go 44.3%
  • HTML 29.7%
  • CSS 24.9%
  • JavaScript 1.1%
2026年07月07日 18:31:28 +02:00
cli refactor: polished already existing commands in CLI 2026年07月07日 18:31:28 +02:00
web fix: redirect to project page after creating a new one 2026年07月06日 20:48:59 +02:00
website fix: correct path for sub-files in the explorer of projects 2026年07月06日 21:36:12 +02:00
.gitignore refactor: polished already existing commands in CLI 2026年07月07日 18:31:28 +02:00
go.mod Changed and fixed many things. 2026年06月25日 14:37:32 +02:00
languages.json Changed and fixed many things. 2026年06月25日 14:37:32 +02:00
LICENSE Increased configuration option and fixed a bug of the display of cli 2026年04月07日 20:54:01 +02:00
README chore: last revision of README, I promise 2026年07月06日 22:27:09 +02:00
snippet.db Initial commit 2025年12月19日 19:18:52 +01:00
test.txt refactor: polished already existing commands in CLI 2026年07月07日 18:31:28 +02:00

========================================
Diskhub - A Local Alternative to GitHub
========================================
--- Why Diskhub? ---
Honestly, you probably shouldn't use it yet. It's still a work in progress and needs polishing.
However, it's a fun technical challenge: a local tool to visualize and manage your projects
directly from your disk—no Git or SaaS required.
--- Features ---
Diskhub reads files directly from disk (no commits, history, or Git features).
But it still offers:
 * Global statistics:
 - Number of projects, lines of code, files
 - Language breakdown (with percentages)
 - Distribution by status (Idea, Started, Functional, Finished, Archived)
 * Integrated file explorer (per project and global)
 * Ollama Chat integration (local AI chat)
 * Snippets Manager: save, edit, copy, and search your code snippets
 * Per-project statistics (e.g., 52% Go, 47% HTML, 2% CSS)
 * Basic Wiki per project (Markdown support, tables, links, diagrams)
Everything is developed with minimal JavaScript for compatibility with minimal rendering engines.
--- Configuration ---
Diskhub requires two levels of configuration: global and per-project.
[Global Configuration]
Located at the project root, it includes:
 - config.toml: server address, folders to scan, exclusions, Ollama activation
 - languages.json: defines known languages (name, extensions, comment style, etc.)
/!\ Be careful to include "max-workers" in config.toml under the Diskhub section, else it won't
 lunch.
[Per-Project Configuration]
Each project has a `.diskhub/` folder containing:
 - conf.json: project name, author, description, status, tags, external links
 - .ignore: equivalent to .gitignore (excludes files/folders from indexing)
--- Installation ---
1. Clone and build from source (Go required):
 git clone https://codeberg.org/esmyx/diskhub.git
 cd diskhub
 go build -o diskhub .
2. Run the binary:
 ./diskhub
Required files/folders in the same directory:
 - website/ (templates and assets)
 - config.toml (global config)
 - languages.json (language definitions)
 - snippet.db (snippets database)
--- Project Status ---
Diskhub is a personal project in active development.
Core features work, but improvements are ongoing:
 - CLI (commands: stats, search, show, web server link)
 - Snippets Manager (SQL queries, UI)
 - Media support in file explorer
 - Multi-chat with Ollama (persistent chats)
 - Project management from the web interface
 - Wiki improvements (line selection, WYSIWYG, navigation)
--- License ---
MPL2.0 (see LICENSE for details)