{"id":20751838,"url":"https://github.com/meloencoding/clerk","last_synced_at":"2025-07-21T11:02:56.924Z","repository":{"id":150278125,"uuid":"613094925","full_name":"MeloenCoding/clerk","owner":"MeloenCoding","description":"A multi-platform todo-list cli-application","archived":false,"fork":false,"pushed_at":"2023-09-10T20:05:40.000Z","size":100,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-18T03:43:48.319Z","etag":null,"topics":["rust","todo-list"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MeloenCoding.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2023-03-12T21:24:39.000Z","updated_at":"2023-03-28T22:39:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"5a87eca3-3c1e-456b-b507-b88cf72201b2","html_url":"https://github.com/MeloenCoding/clerk","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/MeloenCoding%2Fclerk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeloenCoding%2Fclerk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeloenCoding%2Fclerk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeloenCoding%2Fclerk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MeloenCoding","download_url":"https://codeload.github.com/MeloenCoding/clerk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243052466,"owners_count":20228393,"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":["rust","todo-list"],"created_at":"2024-11-17T08:38:30.056Z","updated_at":"2025-03-11T14:34:01.423Z","avatar_url":"https://github.com/MeloenCoding.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# clerk\n#### A multi-platform todo-list cli-application\n\n## Usage\nThe use of this application is pretty simple. You should first download the latest release.\n\nIf you're on windows you could just install the clerk.exe and your pretty much done.\n\nIf you're on linux or on mac you should first download the given .zip or .tar.gz and extract it. Then\nyou should compile it by using 'cargo build --release'. If you don't have cargo or rustc installed \nyou should first do that. Just go to the offical rust site and follow their instructions.\n\nThat's it, you should be able to run the file now. But if you want easy access to your list you should\nfirst add it to your PATH variables. \n\nAfter you've done that, close your terminal and fire it back up again.\nYou should be able to just type 'clerk' and get greeted by an empty list.\n\nTo see which options you have and which commands are available, just type the '-h' flag after a command.\nLike this: \n```bash\n$ clerk -h\n# returns all the commands you could use\n\n$ clerk\n# returns your todolist \n\n```\n## Example \nHow to add a task with a subtask and flag it as doing \n```bash\n$ clerk add \"Main task\"\n# add the main task\n\n$ clerk add \"Sub task of the Main task\" -s 0\n# -s flag marks the input as a subcommand of index 0\n# usage: clerk add \u003cStringTask\u003e -s \u003cIndexOfMaintask\u003e\n\n$ clerk mark 0 0 -d\n# marks the subtask 0 of maintask 0 as doing\n\n$ clerk mark 0 -d\n# marks the maintask as doing\n```\nRemove a main task or subtask\n```bash\n$ clerk mark 0 0 -r\n# removes the subcommand 0 of main task 0\n```\n\n## Config\nThese are the default locations for different operating systems\n```\nLinux:   /home/alice/.config/clerk\nWindows: C:\\Users\\Alice\\AppData\\Roaming\\meloencoding\\clerk\nmacOS:   /Users/Alice/Library/Application Support/dev.meloencoding.clerk\n```\n\n```toml\n# note: toml doesn't support comments so remove everything after every '#'\n[settings]\nlocal = false # use local_location\nuse_unicode = false # set to true if you experience weird characters in your terminal\ncolor_blind = true # if you don't like the colors or if experience weird characters in your terminal, set to true\npage_size = 5 # set the page size when you run 'clerk'\n\n[locations]\nconfig_dir = '' # gets set when you first run the program. you could change it to a custom location \nlocal_location = '' # gets set when you first run the program. you could change it to a custom location \nremote_location = \"\" # you need to set this your self to the location of your compatible api\n\n# if you use some sort of validation in your api, you could set these to check validation in your api\n[api]\nremote_key = \"\" \napp_id = \"\"\napp_key = \"\"\n```\n\n## External use\nIf you want to use the external function you'll need to have a compatible API. In the source there is a file called 'clerk.ts'. If you \nhave a expressjs server you could just follow the instructions in the file. \n\nIf not, \n\nyou just need only one endpoint that has some sort of switch case for a string called \"/show\" and \"/set\". Both are self \nexplaining in function. The show function should read out your data file and the set function should rewrite the entire file. \nBoth need to return a json body with a valid key. Of course the show function should also return the value of the recently read\nfile in an data key. \n\nFor reference, check out 'clerk.ts'.\n\nAfter you've succesfully started your api you should now add it to the 'remote_location' option in the config file. Check the 'Config' \nparagraph for the location of your OS. Also don't forget to change 'local' to false in your config.\n\nFor questions, please open an issue on this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeloencoding%2Fclerk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeloencoding%2Fclerk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeloencoding%2Fclerk/lists"}