{"id":20119854,"url":"https://github.com/shellshape/ghostwriter","last_synced_at":"2025-07-11T15:17:30.207Z","repository":{"id":99796344,"uuid":"574952888","full_name":"shellshape/ghostwriter","owner":"shellshape","description":"A little CLI tool to record changes in a file and replay them step by step.","archived":false,"fork":false,"pushed_at":"2022-12-06T12:44:36.000Z","size":9,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-09T10:56:15.909Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","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/shellshape.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-12-06T12:43:24.000Z","updated_at":"2023-08-19T15:22:46.000Z","dependencies_parsed_at":"2023-04-10T16:17:40.977Z","dependency_job_id":null,"html_url":"https://github.com/shellshape/ghostwriter","commit_stats":null,"previous_names":["shellshape/ghostwriter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/shellshape/ghostwriter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellshape%2Fghostwriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellshape%2Fghostwriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellshape%2Fghostwriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellshape%2Fghostwriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shellshape","download_url":"https://codeload.github.com/shellshape/ghostwriter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellshape%2Fghostwriter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264837934,"owners_count":23671121,"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":[],"created_at":"2024-11-13T19:17:26.797Z","updated_at":"2025-07-11T15:17:29.808Z","avatar_url":"https://github.com/shellshape.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ghostwriter\n\n\u003e **Note**  \n\u003e If you are using this for any kind of video content, it would be very kind if you could give credits to this repository in the details / description of the video.\n\nA little CLI tool to record changes in a file and replay them step by step.\n\nThis tool is designed to be used with editors like VSCode which are able to watch a file for changes and then instantly display it in the interface as the file changes on disk.\n\n## Demo\n\nhttps://user-images.githubusercontent.com/16734205/205912305-4a304f6e-2a0b-44e0-a9bb-847ecd32af4c.mov\n\n## Usage\n\n### Record\n\nFirst of all, create and open the desired file to record. In this example, `main.go`. Now, start the recording with the following command.\n```\nghostwriter record main.go\n```\nAfter that, enter the code you want to show to the file as ususal. Everythime you save the file (for example via \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eS\u003c/kbd\u003e), a new snapshot will be created in the `timeline/` directory (you can also change the directory by passing it via the `--timeline` argument).\n\nNow, when you have finished your recording, press \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eC\u003c/kbd\u003e into the console where ghostwriter is running to stop the recording.\n\n### Replay\n\nSimply run the following command to replay your recording.\n```\nghostwriter replay main.go\n```\n\u003e **Note** Here you can also specify an alternative directory for your timeline files with the `--timeline` argument.\n\nAfter that, the recording will be replayed in the given file (in this case `main.go`). The file will be created if not existent or overwritten if it already existed. Simply open the file now in your editor. Now, simply press the \u003ckbd\u003eEnter\u003c/kbd\u003e key on your keyboard inside the terminal where gostwrietr is running to manually advance the recorded steps.\n\n\u003e **Note** You can also pass a duration with the `--duration` argument to automatically advance the replayin a given time period.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellshape%2Fghostwriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshellshape%2Fghostwriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellshape%2Fghostwriter/lists"}