{"id":34057647,"url":"https://github.com/noqqe/cmddocs","last_synced_at":"2026-04-07T15:33:22.260Z","repository":{"id":25343724,"uuid":"28771130","full_name":"noqqe/cmddocs","owner":"noqqe","description":"An interactive commandline interface for your personal docs using python, Cmd, git and markdown","archived":false,"fork":false,"pushed_at":"2021-02-01T07:07:19.000Z","size":238,"stargazers_count":64,"open_issues_count":0,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-05T16:47:16.653Z","etag":null,"topics":["cmdi","command-line","docs","markdown","notes","python","wiki"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noqqe.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-04T10:17:43.000Z","updated_at":"2026-01-04T02:50:34.000Z","dependencies_parsed_at":"2022-08-23T23:51:14.587Z","dependency_job_id":null,"html_url":"https://github.com/noqqe/cmddocs","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/noqqe/cmddocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noqqe%2Fcmddocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noqqe%2Fcmddocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noqqe%2Fcmddocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noqqe%2Fcmddocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noqqe","download_url":"https://codeload.github.com/noqqe/cmddocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noqqe%2Fcmddocs/sbom","scorecard":{"id":694107,"data":{"date":"2025-08-11","repo":{"name":"github.com/noqqe/cmddocs","commit":"5cc61ec36e153c380f81b60717931eb8ff428b98"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 1/26 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-app.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/noqqe/cmddocs/python-app.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-app.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/noqqe/cmddocs/python-app.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/python-app.yml:26","Warn: pipCommand not pinned by hash: .github/workflows/python-app.yml:27","Warn: pipCommand not pinned by hash: .github/workflows/python-app.yml:28","Warn: pipCommand not pinned by hash: .github/workflows/python-app.yml:29","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python-app.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T03:09:26.528Z","repository_id":25343724,"created_at":"2025-08-22T03:09:26.528Z","updated_at":"2025-08-22T03:09:26.528Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31518607,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["cmdi","command-line","docs","markdown","notes","python","wiki"],"created_at":"2025-12-14T03:46:09.203Z","updated_at":"2026-04-07T15:33:22.254Z","avatar_url":"https://github.com/noqqe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://travis-ci.org/noqqe/cmddocs.svg?branch=master\n       :target: https://travis-ci.org/noqqe/cmddocs\n\n.. image:: https://codecov.io/gh/noqqe/cmddocs/branch/master/graph/badge.svg\n     :target: https://codecov.io/gh/noqqe/cmddocs\n\ncmddocs\n=======\n\n``cmddocs`` is an interactive commandline wiki. It\nlets you easily maintain your docs/cheetsheets/notes using:\n\n- Plain Text Files\n- Write ``markdown`` in your local Editor\n- View in your local Pager\n- Versioning with ``git``\n\ncmddocs is like a framework around your plaintext files.\n\nWhy ?\n-----\n\nI kind of started ``cmddocs`` because I couldn't find something like\nthis on the internet. Here's my usecase. Im working as a DevOps guy\nbeing in touch with various types of software, languages, tools,\noperating systems and databases. To remember all those things I need a\nplace to store commands, workflows and short howtos.\n\nMost of the software I use (and love) runs on a OpenBSD Box on the\ninternet and are commandline-based. These are\n`mutt \u003chttp://www.mutt.org\u003e`__,\n`taskwarrior \u003chttp://taskwarrior.org\u003e`__,\n`jrnl \u003chttp://maebert.github.io/jrnl/\u003e`__,\n`weechat \u003chttp://weechat.org\u003e`__ and so on...But i was missing a tool\nfor documentation.\n\nAfter switching to just plaintext files using\n``vim`` and ``git`` it was also a bit annoying. So I wrote\n``cmddocs`` to make it easier for me to handle my plaintext files.\n\nMarkdown Rendering\n------------------\n\n``cmddocs`` uses the `mistune \u003chttps://github.com/lepture/mistune\u003e`__ lexer to\nwrap markdown with ansi control sequences instead of html tags.\n\nIt looks something like this.\n\n.. image:: https://raw.github.com/noqqe/cmddocs/master/cmddocs-md2ascii.png\n\nDemo\n----\n\nTo give you an idea what it looks/feels like I created a short terminal\nrecording.\n\n`asciinema cmddocs demo \u003chttps://asciinema.org/a/15168\u003e`__\n\nInstallation\n------------\n\n::\n\n    pip install cmddocs\n\nAlso make sure you have `tree` installed.\n\n\nConfiguration\n-------------\n\nCreate ``.cmddocsrc`` file in your $HOME with the following content\n(adjust to your needs):\n\n::\n\n    [General]\n    Datadir = /home/noqqe/Docs\n    Default_Commit_Message = small changes\n    Excludedir = .git/\n    Editor = /usr/local/bin/vim\n    # EditorFlags = -C\n    Pager = /usr/bin/less\n    PagerFlags = -fr\n    Prompt = cmddocs\u003e\n    Promptcolor = 37\n    Intro_Message = cmddocs - press ? for help\n    Mail = mail@example.org\n    Default_Extension = md\n\n    [Colors]\n    Header12 = 37\n    Header345 = 37\n    Codeblock = 92\n\nThe only required option is \"Datadir\", everything else will be guessed\nor defaults to a sane default value. Once you start cmddocs.py the CLI\nwill be shown. Use ``help`` for commands.\n\nQuick Start\n-----------\n\nAt first, create a very minimal config, like\n\n::\n\n    [General]\n    Datadir = /home/noqqe/Docs\n    Editor = /usr/local/bin/vim\n    Pager = /usr/bin/less\n\nThen you can start using cmddocs.\n\n::\n\n    $ cmddocs\n    cmddocs - press ? for help\n    cmddocs\u003e help\n\n    Documented commands (type help \u003ctopic\u003e):\n    ========================================\n    EOF  delete  e     help  list  mail  pwd     search  undo\n    cd   diff    edit  info  log   move  revert  stats   version\n    d    dirs    exit  l     ls    mv    rm      status  view\n\n    cmddocs\u003e help l\n\n        Show files in current working dir\n\n    cmddocs\u003e help log\n\n        Show git logs of your docs.\n\n        Usage: log                      # default loglines: 10)\n               log 20                   # show 20 loglines\n               log 20 article           # show log for specific article\n               log databases/mongodb 3  # same\n\nCommand Documentation\n---------------------\n\n``cd``\n------\n\nChange directory\n\n::\n\n        Usage:\n            cd Programming/\n            cd\n\n``delete``, ``rm``\n------------------\n\nDelete an article\n\n::\n\n        Usage:\n            delete databases/mongodb\n            rm databases/mssql\n\n\n``dirs``, ``d``\n---------------\n\nShow directories in current working dir\n\n::\n\n        Usage:\n            dirs\n            d\n            dirs Databases/\n\n\n``e``, ``edit``\n---------------\n\nEdit or create new article.\n\n::\n\n        Usage:\n            edit databases/mongodb\n            edit intro\n\n\n\n``list``, ``l``, ``ls``\n-----------------------\n\nShow files in current working dir\n\n::\n\n        Usage:\n            list\n            l\n            list Databases/\n\n\n``move``, ``mv``\n----------------\n\nMove an article to a new location\n\n::\n\n        Usage:\n            move databases/mongodb databases/MongoDB\n            move life/foo notes/foo\n            mv life/foo notes/foo\n\n``view``\n--------\n\nView an article. Creates temporary file with converted markdown to\nansi colored output. Opens your PAGER. (Only less supported atm)\n\n::\n\n        Usage:\n            view databases/mongodb\n            view intro\n\n``mail``\n--------\n\nMail an article to a friend\n\n::\n\n        Usage:\n            mail databases/mongodb\n            Recipient: mail@example.net\n\n            mail programming/r/loops\n            mail intro\n\n``pwd``\n-------\n\nShow current directory\n\n::\n\n        Usage:\n            pwd\n\n``search``\n----------\n\nSearch for keyword in current directory\n\n::\n\n        Usage:\n            search mongodb\n            search foo\n\n``undo``, ``revert``\n-------------------\n\nYou can revert your changes (use revert from git)\n\n::\n\n\n        Usage:\n            undo HEAD\n            undo 355f375\n\n        Will ask for confirmation.\n\n``diff``\n--------\n\nShow git diffs between files and commits\n\n::\n\n        Usage:\n            diff 7                   # show diff for last 7 changes\n            diff 1 article           # show diff for last change to article\n            diff                     # show last 5 diffs\n\n``info``\n--------\n\nShow infos for an article\n\n::\n\n        Usage:\n            info article\n            info Databases/mongodb\n            Created: 2014-01-18 11:18:03 +0100\n            Updated: 2015-10-23 14:14:44 +0200\n            Commits: 26\n            Lines: 116\n            Words: 356\n            Characters: 2438\n\n``log``\n--------\n\nShow git logs of your docs.\n\n::\n\n        Usage:\n            log                      # default loglines: 10)\n            log 20                   # show 20 loglines\n            log 20 article           # show log for specific article\n            log databases/mongodb 3  # same\n\n``status``\n----------\n\nShow git repo status of your docs\n\n::\n\n        Usage:\n            status\n\n``stats``\n---------\n\nCalculate some statistics on your docs\n\n::\n\n        Usage:\n            stats\n\n``exit``, ``EOF``\n-----------------\n\nExit cmddocs\n\n::\n\n        Usage:\n            exit\n\n\n``help``\n--------\n\nList available commands with \"help\" or detailed help with \"help cmd\".\n\n``version``\n-----------\n\nShow version of cmddocs\n\n::\n\n        Usage:\n            version\n\n\nChangelog\n---------\n\nSee Changelog_.\n\n.. _Changelog: https://github.com/noqqe/cmddocs/blob/master/CHANGELOG.rst\n\nLicense\n-------\n\nSee License_.\n\n.. _License: https://github.com/noqqe/cmddocs/blob/master/License.txt\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoqqe%2Fcmddocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoqqe%2Fcmddocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoqqe%2Fcmddocs/lists"}