{"id":20367552,"url":"https://github.com/earthstar-project/user_scripts","last_synced_at":"2026-03-15T00:16:24.808Z","repository":{"id":129368046,"uuid":"562956971","full_name":"earthstar-project/user_scripts","owner":"earthstar-project","description":"A repo full of scripts for running and reference.","archived":false,"fork":false,"pushed_at":"2023-01-18T11:22:27.000Z","size":94,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-11T06:23:10.289Z","etag":null,"topics":["deno","earthstar","scripts"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/earthstar-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2022-11-07T15:57:20.000Z","updated_at":"2025-02-02T01:04:04.000Z","dependencies_parsed_at":"2023-07-29T00:46:56.582Z","dependency_job_id":null,"html_url":"https://github.com/earthstar-project/user_scripts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fuser_scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fuser_scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fuser_scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fuser_scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/earthstar-project","download_url":"https://codeload.github.com/earthstar-project/user_scripts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248522377,"owners_count":21118268,"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":["deno","earthstar","scripts"],"created_at":"2024-11-15T00:33:08.794Z","updated_at":"2026-03-15T00:16:24.752Z","avatar_url":"https://github.com/earthstar-project.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Earthstar Scripts\n\nA collection of [Earthstar](https://earthstar-project.org) scripts for reading,\nwriting, syncing, and archiving share data.\n\nIt's like a CLI, but better: you can read, modify, and extend the available\nscripts so they're just the way you want them.\n\nAll these scripts pull their settings from the same source, so you can reuse a\nkeypair and all your favourite shares and servers between them.\n\nAll share replica data is persisted to the filesystem in `share_data`.\n\n## Set up\n\n1. Clone this repository\n2. Install the Deno runtime\n   ([Instructions](https://deno.land/manual@v1.29.1/getting_started/installation))\n3. Test it all works with `deno run scripts/new_author.ts suzy`\n\n## Available scripts\n\n### `add_server.ts`\n\nAdd the URL of a server to the shared settings so that it can be synced with.\n\n### `add_share.ts`\n\nAdds an existing share to the shared settings so that other scripts can use it.\nThe first argument is the URL to be saved.\n\n### `archive_share.ts`\n\nArchives a share replica's data to a zip file. You can then put that archive on\na USB key and give it to a friend for syncing, or back it up.\n\n### `current_author.ts`\n\nDisplay the current author keypair saved to shared settings.\n\n### `forget_author.ts`\n\nForget the current author keypair saved to shared settings.\n\n### `list_authors.ts`\n\nLists all authors from a share replica.\n\n### `list_paths.ts`\n\nLists all document paths from a share replica.\n\n### `list_servers.ts`\n\nList all servers saved to shared settings.\n\n### `list_shares.ts`\n\nList all shares saved to shared settings.\n\n### `new_author.ts`\n\nGenerates a new author keypair from a shortname and adds it to shared settings\nfor other scripts to use. The sole argument of this script is the four character\nshortname used in the new keypair.\n\n### `new_share.ts`\n\nGenerates a new share keypair from a name and adds it to shared settings for\nother scripts to use.\n\n### `remove_server.ts`\n\nRemoves a server from the list of servers known by `SharedSettings`.\n\n### `remove_share.ts`\n\nRemoves a share from the list of known shares.\n\n### `save_attachment.ts`\n\nWrite an attachment to your filesystem.\n\n### `set_author.ts`\n\nTake an existing author keypair and save it to the shared settings for other\nscripts to use.\n\n### `share_info.ts`\n\nPrints some info about a share replica.\n\n### `show_share_secret.ts`\n\nDisplays the secret of a chosen share.\n\n### `sync_archive.ts`\n\nTakes a zipped share archive, and syncs it with our own data for that share.\nOptionally updates the zipped archive. Useful for when you get that USB key from\nyour friend.\n\n### `sync_dir.ts`\n\nSync the contents of a filesystem directory with a share replica.\n\n### `sync_all.ts`\n\nSync all known shares with all known servers (only shares held in common by both\nsides will be synced).\n\n### `sync_with_server.ts`\n\nSync one share replica with one Earthstar server.\n\n### `write_replica`\n\nWrite some data to a share replica with free-form text or a file on the\nfilesystem.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fearthstar-project%2Fuser_scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fearthstar-project%2Fuser_scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fearthstar-project%2Fuser_scripts/lists"}