earthstar-project / user_scripts

A repo full of scripts for running and reference.

Earthstar Scripts

A collection of Earthstar scripts for reading, writing, syncing, and archiving share data.

It's like a CLI, but better: you can read, modify, and extend the available scripts so they're just the way you want them.

All these scripts pull their settings from the same source, so you can reuse a keypair and all your favourite shares and servers between them.

All share replica data is persisted to the filesystem in share_data.

Set up

1. Clone this repository
2. Install the Deno runtime (Instructions)
3. Test it all works with deno run scripts/new_author.ts suzy

Available scripts

add_server.ts

Add the URL of a server to the shared settings so that it can be synced with.

add_share.ts

Adds an existing share to the shared settings so that other scripts can use it. The first argument is the URL to be saved.

archive_share.ts

Archives a share replica's data to a zip file. You can then put that archive on a USB key and give it to a friend for syncing, or back it up.

current_author.ts

Display the current author keypair saved to shared settings.

forget_author.ts

Forget the current author keypair saved to shared settings.

list_authors.ts

Lists all authors from a share replica.

list_paths.ts

Lists all document paths from a share replica.

list_servers.ts

List all servers saved to shared settings.

list_shares.ts

List all shares saved to shared settings.

new_author.ts

Generates a new author keypair from a shortname and adds it to shared settings for other scripts to use. The sole argument of this script is the four character shortname used in the new keypair.

new_share.ts

Generates a new share keypair from a name and adds it to shared settings for other scripts to use.

remove_server.ts

Removes a server from the list of servers known by SharedSettings.

remove_share.ts

Removes a share from the list of known shares.

save_attachment.ts

Write an attachment to your filesystem.

set_author.ts

Take an existing author keypair and save it to the shared settings for other scripts to use.

share_info.ts

Prints some info about a share replica.

show_share_secret.ts

Displays the secret of a chosen share.

sync_archive.ts

Takes a zipped share archive, and syncs it with our own data for that share. Optionally updates the zipped archive. Useful for when you get that USB key from your friend.

sync_dir.ts

Sync the contents of a filesystem directory with a share replica.

sync_all.ts

Sync all known shares with all known servers (only shares held in common by both sides will be synced).

sync_with_server.ts

Sync one share replica with one Earthstar server.

write_replica

Write some data to a share replica with free-form text or a file on the filesystem.

user_scripts's Issues

Cannot sync with websocket fly server

Noticed that I could not get the "sync_with_server.ts" and "sync_all.ts" commands to work with my websockets server.
Keep getting the status 404 not found.

$ user_scripts % deno run -A scripts/sync_with_server.ts 
 ? Pick a share › +data.abc123456
Syncing...
 ? What is the URL of the server you'd you like to sync with? › wss://my-server-domain-at.fly.dev/earthstar-api/v2
Save wss://my-server-domain-at.fly.dev/earthstar-api/v2 to favourite servers? [y/N] y
Syncing...
error: Uncaught (in promise) NetworkError: failed to connect to WebSocket: HTTP error: 404 Not Found

The share was added before to the server using an entry in known_shares.json.

Is this a problem with my sync server? It is using ExtensionSyncWebsocket.

Perhaps we need instructions on what kind of server is compatible with these scripts?

Versions:

deno 1.29.4 (release, aarch64-apple-darwin)
v8 10.9.194.5
typescript 4.9.4

Add instructions on how to run scripts in README