{"id":17978305,"url":"https://github.com/adrianvollmer/congruence","last_synced_at":"2025-03-25T17:31:22.285Z","repository":{"id":49400032,"uuid":"235452228","full_name":"AdrianVollmer/Congruence","owner":"AdrianVollmer","description":"A command line interface to Atlassian Confluence","archived":false,"fork":false,"pushed_at":"2024-07-16T07:47:59.000Z","size":524,"stargazers_count":37,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-20T14:22:54.369Z","etag":null,"topics":["cli-app","confluence","terminal-based","tui","urwid"],"latest_commit_sha":null,"homepage":null,"language":"Python","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/AdrianVollmer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2020-01-21T22:14:49.000Z","updated_at":"2024-07-16T07:48:02.000Z","dependencies_parsed_at":"2024-10-29T18:09:55.277Z","dependency_job_id":null,"html_url":"https://github.com/AdrianVollmer/Congruence","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdrianVollmer%2FCongruence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdrianVollmer%2FCongruence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdrianVollmer%2FCongruence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdrianVollmer%2FCongruence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AdrianVollmer","download_url":"https://codeload.github.com/AdrianVollmer/Congruence/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245510664,"owners_count":20627236,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cli-app","confluence","terminal-based","tui","urwid"],"created_at":"2024-10-29T17:33:03.781Z","updated_at":"2025-03-25T17:31:22.279Z","avatar_url":"https://github.com/AdrianVollmer.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Congruence\n==========\n\nA command line interface to Atlassian Confluence.\n\nBecause Confluence at my company loads a whopping 9.13MB of JavaScript just\nto display the home page.\n\nAbout\n-----\n\nThis program is inspired by applications like mutt, newsboat or tig and\ntakes a minimalist approach to accessing this bloated but quite useful piece\nof software.\n\nFortunately, on the flip side, Confluence behaves nicely when interfacing\nwith other things. There is an API! Check it out:\n\n[![asciicast](https://asciinema.org/a/vEGpJpHqyX3S4wMNCbkuJCLRx.svg)](https://asciinema.org/a/vEGpJpHqyX3S4wMNCbkuJCLRx)\n\n(This is from a public Confluence. If you see yourself in this asciicast and\ndon't like it, contact me.)\n\nI'm a big believer in minimalism and CLI/TUI tools. They always respond\nvirtually instantly to user input (safe for communication over the network)\nand their keyboard-driven nature makes it a breeze to work with once you\nhave the keyboard mappings down. Plus, their true power often comes through\ntheir ability to interact with other programs and scripts, which makes\nautomation so much easier. Displaying Confluence pages in a TUI browser like\nelinks or lynx naturally removes all distractions and focuses on what's\nmost important: the content. Besides pages with lots of images or tables,\nthis makes it surprisingly pleasant to read. And your fully fledged GUI\nbrowser is just one key press away...\n\nNaturally, Congruence was written entirely in vim.\n\nThe goal is primarily to consume content served by Confluence and have\nminimal interactions, such as liking content and posting comments. Editing\npages is out of scope for sure.\n\nDisclaimer: I am not affiliated with Atlassian in any way. At the point of\nwriting, I only have one Confluence instance to work with. I also never\ninstalled a Confluence and I have only a vague idea of what is a plugin and\nwhat is core functionality. I'm just a regular power user. This will work\nonly with Confluence 6.0 or higher.\n\nGetting started\n---------------\n\nMake sure you have all dependencies installed, most importantly Python 3.6\nor higher. The easiest is to just execute `pip3 install .`, which will put\nan executable named `congruence` in your `~/.local/bin` directory, which\nmust be in your `$PATH`. Alternatively, use your favorite virtual\nenvironment manager.\n\nNext, copy `config.yaml.sample` to `$XDG_CONFIG_HOME/congruence/config.yaml` (or\n`$HOME/.config/congruence/` if `$XDG_CONFIG_HOME` is not defined) and edit it to\nyour liking.\n\nWhen using the app, you can always press '?' to see what's going on and what\nyour next options are.\n\nIdeas for the next release\n--------------------------\n\n* Cache metadata\n* Keep track of 'seen'/'unseen' objects\n* Extract links and images of content\n* Show scroll  percentage in title bar\n* Improve search\n* Add a 'versions' view and allow diffs between arbitrary versions\n* Edit comments\n\nLicense\n-------\n\nGPLv3. See LICENSE for more information.\n\nAuthor\n------\n\nAdrian Vollmer, 2020\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianvollmer%2Fcongruence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrianvollmer%2Fcongruence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianvollmer%2Fcongruence/lists"}