{"id":19115258,"url":"https://github.com/saadmk11/logbook-cli","last_synced_at":"2025-10-06T22:05:10.589Z","repository":{"id":62576623,"uuid":"367265920","full_name":"saadmk11/logbook-cli","owner":"saadmk11","description":"Command Line Tool to Keep Your Daily Events Recorded. Made with Python, Typer \u0026 SQLAlchemy","archived":false,"fork":false,"pushed_at":"2021-05-14T14:50:21.000Z","size":24,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-30T22:52:25.333Z","etag":null,"topics":["cli","cli-app","command-line-app","command-line-interface","command-line-tool","logbook","logbooks","notebook","poetry","python","python3","sql","sqlalchemy","sqlite","sqlite3","typer","typer-cli"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/logbook-cli/","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/saadmk11.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}},"created_at":"2021-05-14T06:08:42.000Z","updated_at":"2024-07-24T08:38:22.000Z","dependencies_parsed_at":"2022-11-03T19:09:30.080Z","dependency_job_id":null,"html_url":"https://github.com/saadmk11/logbook-cli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saadmk11%2Flogbook-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saadmk11%2Flogbook-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saadmk11%2Flogbook-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saadmk11%2Flogbook-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saadmk11","download_url":"https://codeload.github.com/saadmk11/logbook-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251795425,"owners_count":21645020,"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","cli-app","command-line-app","command-line-interface","command-line-tool","logbook","logbooks","notebook","poetry","python","python3","sql","sqlalchemy","sqlite","sqlite3","typer","typer-cli"],"created_at":"2024-11-09T04:45:55.662Z","updated_at":"2025-10-06T22:05:05.548Z","avatar_url":"https://github.com/saadmk11.png","language":"Python","readme":"![Logbook-cli-banner](https://user-images.githubusercontent.com/24854406/118286755-9fbe4980-b4f4-11eb-8c53-1af215343e8e.png)\n\n# logbook-cli\n\nKeep Your Daily Events Recorded on Your Logbook Using Command Line.\n\n\n## How Does It Work?\n\n`logbook-cli` is created using python. It uses `typer` for the Command Line Interface\nand `SQLAlchemy` to interact with the database (`sqlite`).\nAll the log entries are stored into the `sqlite` database.\n\n\n## Installation\n\nYou can install `logbook-cli` by using `pip`:\n\n```console\npip install logbook-cli\n```\n\n\n## Configuration\n\n`logbook-cli` stores the `sqlite` database in `~/.logbook/` directory by default.\n\nYou can use `LOG_BOOK_DATABASE_URL` environment variable to use a different location.\n\n**Example:**\n\n```console\nexport LOG_BOOK_DATABASE_URL=sqlite:///logbook.sqlite3\n```\n\n\n## How to use `logbook-cli`\n\n**Usage**\n\n```console\n$ logbook-cli [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `add`: Add a log entry to the logbook.\n* `delete`: Delete a log entry using it's ID.\n* `edit`: Update a log entry using it's ID.\n* `find`: List all log entries that match the argument.\n* `list`: List all log entries in a table, limits upto...\n* `view`: View a single log entry using it's ID.\n\n### `logbook-cli add`\n\nAdd a log entry to the logbook.\n\n**Usage**:\n\n```console\n$ logbook-cli add [OPTIONS] DESCRIPTION\n```\n\n**Arguments**:\n\n* `DESCRIPTION`: Description of the log entry  [required]\n\n**Options**:\n\n* `-d, --date [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]`: Date of the log entry  [default: **log entry date**]\n* `-t, --time [%H:%M:%S|%I:%M %p]`: Time of the log entry  [default: **log entry time**]\n* `--help`: Show this message and exit.\n\n**Example:**\n\n```console\n$ logbook-cli add -d \"2021-05-10\" -t \"10:00 PM\" \"This is a Test Log Entry\"\n```\n\n### `logbook-cli delete`\n\nDelete a log entry using it's ID.\n\n**Usage**:\n\n```console\n$ logbook-cli delete [OPTIONS] ID\n```\n\n**Arguments**:\n\n* `ID`: ID of the log entry  [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n**Example:**\n\n```console\n$ logbook-cli delete 1\n```\n\n### `logbook-cli edit`\n\nUpdate a log entry using it's ID.\n\n**Usage**:\n\n```console\n$ logbook-cli edit [OPTIONS] ID\n```\n\n**Arguments**:\n\n* `ID`: ID of the log entry  [required]\n\n**Options**:\n\n* `--description TEXT`: New Description for the log entry  [default: ]\n* `-d, --date [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]`: New Date for the log entry\n* `-t, --time [%H:%M:%S|%I:%M %p]`: New Time for the log entry\n* `--help`: Show this message and exit.\n\n**Example:**\n\n```console\n$ logbook-cli edit 1 -d \"2021-05-10\" -t \"10:00 PM\" --description \"This is a Edited Test Log Entry\"\n```\n\n### `logbook-cli find`\n\nList all log entries that match the argument.\n\n**Usage**:\n\n```console\n$ logbook-cli find [OPTIONS] DESCRIPTION_CONTAINS\n```\n\n**Arguments**:\n\n* `DESCRIPTION_CONTAINS`: String that may match log entry description  [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n**Example:**\n\n```console\n$ logbook-cli find \"test\"\n```\n\n### `logbook-cli list`\n\nList all log entries in a table, limits upto 40 log entries.\n\n**Usage**:\n\n```console\n$ logbook-cli list [OPTIONS]\n```\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n**Example:**\n\n```console\n$ logbook-cli list\n```\n\n### `logbook-cli view`\n\nView a single log entry using it's ID.\n\n**Usage**:\n\n```console\n$ logbook-cli view [OPTIONS] ID\n```\n\n**Arguments**:\n\n* `ID`: ID of the log entry  [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n**Example:**\n\n```console\n$ logbook-cli view 1\n```\n\n## Screenshot\n\n![logbook-cli-screenshot](https://user-images.githubusercontent.com/24854406/118287484-4dc9f380-b4f5-11eb-8e2a-e6bf0bf35942.png)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaadmk11%2Flogbook-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaadmk11%2Flogbook-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaadmk11%2Flogbook-cli/lists"}