{"id":15502930,"url":"https://github.com/evuez/slate","last_synced_at":"2025-04-22T23:20:31.187Z","repository":{"id":42000931,"uuid":"115132287","full_name":"evuez/slate","owner":"evuez","description":"Take notes from you terminal.","archived":false,"fork":false,"pushed_at":"2022-07-04T22:48:30.000Z","size":60,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-21T19:04:41.794Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://hackage.haskell.org/package/slate","language":"Haskell","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/evuez.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}},"created_at":"2017-12-22T16:28:02.000Z","updated_at":"2025-02-21T22:17:16.000Z","dependencies_parsed_at":"2022-08-20T08:22:08.646Z","dependency_job_id":null,"html_url":"https://github.com/evuez/slate","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evuez%2Fslate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evuez%2Fslate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evuez%2Fslate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evuez%2Fslate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evuez","download_url":"https://codeload.github.com/evuez/slate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250338358,"owners_count":21414166,"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":["hacktoberfest"],"created_at":"2024-10-02T09:11:36.926Z","updated_at":"2025-04-22T23:20:31.162Z","avatar_url":"https://github.com/evuez.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# slate - a note taking tool.\n\nA simple tool to take notes from your terminal (and sync them between your devices).\n\n![`slate status`](https://user-images.githubusercontent.com/634827/51380042-13144400-1b11-11e9-846f-114ee282c29c.png)\n\nGenerates markdown [task lists](https://help.github.com/articles/about-task-lists/).\n\n**Table of contents**\n\n - [Install](#install)\n - [Basic usage](#basic-usage)\n - [Configuration](#configuration)\n    - [Callbacks](#callbacks)\n      - [sync](#sync)\n      - [status](#status)\n - [Autocompletion](#autocompletion)\n\n## Install\n\nYou can install it using [stack](https://docs.haskellstack.org/) (requires stack \u003e= 1.6).\n\n```shell\n$ stack install slate\n```\n\n## Basic usage\n\n\u003cpre\u003e\n$ slate --help\nslate - a note taking tool.\n\nUsage: slate COMMAND\n  Slate\n\nAvailable options:\n  -h,--help                Show this help text\n\nAvailable commands:\n  add                      Add a note.\n  done                     Mark a note as done when given a note ID, display\n                           done notes otherwise.\n  todo                     Mark a note as todo when given a note ID, display\n                           todo notes otherwise.\n  doing                    Toggle highlighting on a note when given a note ID,\n                           display notes marked as doing otherwise.\n  remove                   Remove a note.\n  display                  Display a slate.\n  rename                   Rename a slate.\n  wipe                     Wipe a slate.\n  status                   Display the status of a slate.\n  sync                     Sync every slate.\n\n$ slate add \"My *first* note.\"\n$ slate add \"New note!\"\n$ slate display\n0 - My \u003cb\u003efirst\u003c/b\u003e note.\n1 - New note!\n\n$ slate done 0\n$ slate display\n\u003cs\u003e0 - My \u003cb\u003efirst\u003c/b\u003e note.\u003c/s\u003e\n1 - New note!\n\n$ slate display --only=todo # or just slate todo\n1 - New note!\n\n$ slate status\n1 done, 1 todo (2 total).\n50% · 1 done · 1 todo — sync ✔\n▮▮▮▮▮▮▮▮▮▮▮▮▮▮▮▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯\n\n$ slate add \"Fake note\"\n$ slate display\n\u003cs\u003e0 - My \u003cb\u003efirst\u003c/b\u003e note.\u003c/s\u003e\n1 - New note!\n2 - Fake note\n\n$ slate remove 2\n$ slate display\n\u003cs\u003e0 - My \u003cb\u003efirst\u003c/b\u003e note.\u003c/s\u003e\n1 - New note!\n\n$ slate wipe --only=todo\n$ slate display\n\u003cs\u003e0 - My \u003cb\u003efirst\u003c/b\u003e note.\u003c/s\u003e\n\n$ slate todo 0\n$ slate display\n0 - My \u003cb\u003efirst\u003c/b\u003e note.\n\u003c/pre\u003e\n\nLists are stored in `~/.config/slate/` and their default name is the name of your current directory. You can use any other name you want using the `--name` option or by adding a `.slate` file containing the name you want to use.\n\n## Configuration\n\nThe following configuration options can be set in `~/.config/slate/config.toml` (you'll have to create this file).\n\nYou can check out [config.example.toml](https://github.com/evuez/slate/blob/main/config.example.toml) for a configuration example.\n\n### Callbacks\n\nYou must define the commands in this section in a `[callbacks]` table:\n\n```\n[callbacks]\nkey1 = value1\nkey2 = value2\n...\n```\n\n#### sync\n\nYou can use `slate sync` to synchronize your slates. There's no default configuration for this command, so for it to work you'll have to add your own sync command, for example:\n\n```toml\nsync = \"git add . \u0026\u0026 git commit -m 'Update slates'; git pull --rebase origin main \u0026\u0026 git push origin main\"\n```\n\nThis would stage \u0026 commit every updates in `~/.config/slate/`, update your local copy and push your updates to the `origin` remote.\n\n#### status\n\nBy default, `slate status` only displays the number of notes by status. You can add a command in the `status` key that'll be used to check if the slate is synchronized or not, for example:\n\n```toml\nstatus = \"git diff --exit-code $SLATE\"\n```\n\nWhere `$SLATE` will be set to `~/.config/slate/\u003cslate name\u003e.md`. The command must return a non-zero exit code if the slate is out of sync and zero if it's synced.\n\n## Autocompletion\n\nYou can use the following commands to generate a completion script for your shell:\n\n  - Bash: `slate --bash-completion-script $(which slate)`\n  - Zsh: `slate --zsh-completion-script $(which slate)`\n  - Fish: `slate --fish-completion-script (which slate)`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevuez%2Fslate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevuez%2Fslate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevuez%2Fslate/lists"}