{"id":22620058,"url":"https://github.com/adi-df/foucault","last_synced_at":"2026-02-19T11:15:12.446Z","repository":{"id":213981837,"uuid":"735310319","full_name":"Adi-df/foucault","owner":"Adi-df","description":"A small markdown TUI note keeper","archived":false,"fork":false,"pushed_at":"2025-04-07T14:35:41.000Z","size":2758,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-03T23:48:23.895Z","etag":null,"topics":["markdown","notebook","ratatui","rust","sqlite","tui"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Adi-df.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-12-24T12:53:07.000Z","updated_at":"2025-05-02T07:45:28.000Z","dependencies_parsed_at":"2023-12-30T22:26:50.947Z","dependency_job_id":"f7dab607-b1ee-4d9c-a8ab-0c0dfca8975d","html_url":"https://github.com/Adi-df/foucault","commit_stats":null,"previous_names":["adi-df/foucault"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/Adi-df/foucault","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adi-df%2Ffoucault","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adi-df%2Ffoucault/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adi-df%2Ffoucault/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adi-df%2Ffoucault/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Adi-df","download_url":"https://codeload.github.com/Adi-df/foucault/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adi-df%2Ffoucault/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29611012,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T10:52:55.328Z","status":"ssl_error","status_checked_at":"2026-02-19T10:52:26.323Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","notebook","ratatui","rust","sqlite","tui"],"created_at":"2024-12-08T22:11:44.490Z","updated_at":"2026-02-19T11:15:12.430Z","avatar_url":"https://github.com/Adi-df.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Foucault\nA small terminal UI note-taking app.\n\n![Demo](doc/demo.gif)\n\nNote : Demo made using the [Helix](https://github.com/helix-editor/helix) editor for editing notes and scraped data from Wikipedia to fill the notebook.\n\n# Install Foucault\n\n## Shell Installer\n\nThanks to [cargo-dist](https://github.com/axodotdev/cargo-dist), an installer script exists to install foucault with just one command.\n\n```sh\ncurl --proto '=https' --tlsv1.2 -LsSf https://github.com/Adi-df/foucault/releases/download/v0.3.3/foucault-installer.sh | sh\n```\n\n## Binaries\n\nLook through [Releases](https://github.com/Adi-df/foucault/releases) for binaries and MSI installers.\n\n## Building from source\n\nThe easiest way to build foucault from source is to use the [just](https://github.com/casey/just) command runner.\n\n```sh\n# Clone the foucault repo\ngit clone https://github.com/Adi-df/foucault\n# Use build-release to build using optimisation\njust build-release\n# Use prepare-queries and build-dev to build using the dev profile\njust prepare-queries\njust build-dev\n```\n\n# Usage\n\n## Creating your first notebook\n\nFoucault is based on the notion of Notebook which contains notes, tags, etc.\nIt exposes a CLI app made with [clap](https://github.com/clap-rs/clap) to manage notebooks.\nTo create your first notebook, use `foucault create [NAME]`.\nThen open it with `foucault open [NAME]`.\n\n## Using foucault to take notes\n\nThe keymap is detailed when toggling the help bar with `CTRL+H`.\n\nEditing notes works with an external editor set by the `EDITOR` env variable, so that you may use your favorite editor.\nNotes are taken in Markdown with (limited) support. It supports making cross-references between notes by using `[[NOTE_NAME]]`.\n\n## Exposing a notebook / Connecting to one\n\nFoucault supports accessing remote notebooks : Expose the notebook through `foucault serve [NAME]`. And connect to it with `foucault connect http://remotenotebookadress.org`.\n\n# Is it any good ?\n\nProbably not.\n\nFoucault is just a side project I made to take notes in philosophy courses.\nThere are probably plenty of bugs, it's inefficient and missing a lot of features.\nBut it still kinda works, so maybe take a look !\n\n# Built with\n\n  - The fantastic Rust language.\n  - The smashing [clap](https://github.com/clap-rs/clap) command parser.\n  - The amazing [Tokio](https://github.com/tokio-rs/tokio) async runtime.\n  - The wonderful [SQLite](https://www.sqlite.org/) database through the brilliant [SQLx](https://github.com/launchbadge/sqlx) library.\n  - The awesome [axum](https://github.com/tokio-rs/axum) web framework.\n  - The incredible [ratatui](https://github.com/ratatui-org/ratatui) TUI library.\n  - The terrific [just](https://github.com/casey/just) command runner.\n  - The superb [cargo-dist](https://github.com/axodotdev/cargo-dist) app packager.\n  - And many other excellent open source crate.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadi-df%2Ffoucault","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadi-df%2Ffoucault","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadi-df%2Ffoucault/lists"}