earthstar-project / earthstar-cli Goto Github PK

What's the problem you want solved?

earthstar identities generate foobar
ValidationError: name must be between 4 and 4 characters long, but is 6

My first choice was > 4 and I imagine most people will do that too...

Error is a somewhat confusing read also 😅

Is there a solution you'd like to recommend?

Length ~ 16 chars to avoid this?

Do a bulk import/export between earthstar documents and a directory of files.

This might require a lot of configuration, maybe it's better as a separate script.

How do we make earthstar paths safe to use as filenames?

Do we allow subdirectories, or put everything in one flat directory?

Can we use timestamps for two-way sync, or do we have to ask the user what to do when the data doesn't match?

How do we tell the difference between deleted files and empty files? Earthstar doesn't have deletion yet, only empty values (See earthstar-project/earthstar#20 Deletion)

Do we represent directories themselves in Earthstar, or ignore them?

The CLI interacts with the filesystem in two ways:

1. It persists share data to disk using ReplicaDriverFs. The contents of this directory are meant to be opaque to users.
2. It syncs a share to a directory using the earthstar share sync-fs command, writing changes from the disk to the replica and vice versa. The contents of this directory are intended to be interacted with by users.

I saw this cause some confusion with testers before the CLI was launched. Which is the one for Earthstar's use, and which one is for users to interact with?

The only idea I have to counter this is to hide the directories used by ReplicaDriverFs entirely, and ferret them into some application support folder someplace.

Versions:

• Deno 1.26.0
• Earthstar CLI v8.3.5

The Deno.setRaw() error happens when running a command like "earthstar shares latest":

$ earthstar shares latest
 ? Choose a share › error: Uncaught (in promise) TypeError: Deno.setRaw is not a function
      (Deno.setRaw as setRaw)(
                             ^
    at Input.#readChar (https://deno.land/x/[email protected]/prompt/_generic_prompt.ts:285:30)
    at Input.#readKey (https://deno.land/x/[email protected]/prompt/_generic_prompt.ts:273:50)
    at Input.read (https://deno.land/x/[email protected]/prompt/_generic_prompt.ts:169:52)
    at Input.#execute (https://deno.land/x/[email protected]/prompt/_generic_prompt.ts:111:21)
    at async Input.prompt (https://deno.land/x/[email protected]/prompt/_generic_prompt.ts:90:14)
    at async Command.fn (https://deno.land/x/[email protected]/src/share.ts:490:36)
    at async Command.execute (https://deno.land/x/[email protected]/command/command.ts:1026:7)
    at async Command.parse (https://deno.land/x/[email protected]/command/command.ts:940:16)
    at async https://deno.land/x/[email protected]/src/main.ts:23:1

Seems to be related to this denoland/deno#15796

Work-around

Downgrade Deno to version 1.25.4 for now.

What's the problem you want solved?

When trying to follow instructions from https://earthstar-project.org/get-started/install-cli, there is an error and the cli does not install.

command:
deno install --allow-read --allow-write --allow-net --allow-run --allow-env --no-check --unstable -f --location https://earthstar-project.org -n earthstar https://deno.land/x/earthstar_cli/src/main.ts

error:
error: Module not found "https://deno.land/x/crayon/types.ts". at https://deno.land/x/[email protected]/index.ts:8:24

❯ deno --version
deno 1.23.1 (release, aarch64-apple-darwin)
v8 10.4.132.8
typescript 4.7.2

Is there a solution you'd like to recommend?

🤷

Add support for generating and redeeming Earthstar invitation URLs.

Add some commands to make it easier to import/export single documents to files, either as JSON (including the document metadata) or just as the document content.

// new commands
earthstar document
earthstar content [--binary]

// new flags to existing command
earthstar set --fromFile <filename> [--binary]

Usage

// print out a whole document as JSON
earthstar document <dbFilename> <path>

// prints out just document.content
earthstar content <dbFilename> <path>

// redirect it to a file, to export the data out of earthstar
earthstar content <dbFilename> <path> > myfile

// read data from a file to use as the document's content
earthstar set <dbFilename> <authorFile> <path> --fromFile <filename>

// new option --binary means treat the file as binary instead of utf-8
// which means it needs to be encoded/decoded to base64 for storage in Earthstar
earthstar content <dbFilename> <path> --binary
earthstar set <dbFilename> <authorFile> <path> --fromFile <filename> --binary

Or maybe instead of --fromFile, it could try to read from stdin so you could do earthstar set db.sqlite author.json /path < myfile

Tested running the Earthstar cli on a Windows Powershell and command prompt.
It all installs well, but there seems to be a functional issue with the "shares" command where it never returns the control back to the user.

Environment:

Windows 10 Pro Version 21H1 (OS Build 19043.1645)
PowerShell 7.2.2
Copyright (c) Microsoft Corporation.

https://aka.ms/powershell
Type 'help' to get help.

PS C:\Users\johan> earthstar --version
v8.3.3
PS C:\Users\johan> deno --version
deno 1.21.0 (release, x86_64-pc-windows-msvc)
v8 10.0.139.17
typescript 4.6.2

Creating an identity and setting up a share worked in the C:\Users\johan\Shares folder. The sharename.sqlite and sharename.sqlite-journal files are created.

However the command which are related to "shares" never seem to finish or return back the prompt to the user.

The command earthstar shares list does not end; unclear why. Tried using elevated command prompt without success.

The command earthstar identities list works fine.

The command earthstar upgrade works fine.

The command earthstar servers list works fine.

Tried adding the "deno.exe" executable to the "allowed apps" list, but it does not seem to make a difference.

Problem

If running...

npm install --global earthstar-cli

Gives the error...

> node-gyp rebuild --release

No receipt for 'com.apple.pkg.CLTools_Executables' found at '/'.

No receipt for 'com.apple.pkg.DeveloperToolsCLILeo' found at '/'.

No receipt for 'com.apple.pkg.DeveloperToolsCLI' found at '/'.

gyp: No Xcode or CLT version detected!```

The problem is related to setup of the xcode command line tools. They might already be set up, but node is picky about them. (node-gyp is the build tool that compiles native C code such as SQLite, which is used inside Earthstar.)

Solution

At least on MacOS Catalina (15), the solution is

sudo rm -rf /Library/Developer/CommandLineTools
xcode-select --install

Sources:

• nodejs/node-gyp#1927
• https://developer.apple.com/library/archive/technotes/tn2339/_index.html#//apple_ref/doc/uid/DTS40014588-CH1-HOW_CAN_I_UNINSTALL_THE_COMMAND_LINE_TOOLS_

The NPM CLI seems very outdated. Maybe it should have a warning that it doesn't work anymore?

(After earthstar-project/earthstar-pub#3 Make earthstar-pub an importable module)

Would it make sense to embed earthstar-pub into the cli here, to quickly launch a pub?

Would it be useful to show a live stream of write events from a pub, in the command line?

testing inside denoland/deno:alpine-1.25.4 (https://hub.docker.com/r/denoland/deno/)

earthstar identities generate foob --current
Added @foob to stored identities.
/ # earthstar shares generate foob
Generated share address.
 ? No directory for storing shares has been set yet. Where you would you like it? (/root/Shares) › /root/Shares
Added +foob.kvebxpmd1k0a
'schemaVersion  share~/Shares # earthstar shares set
 ? Choose a share › +foob.kvebxpmd1k0a
 ? Choose a path › foo.txt
 ? Enter document content › barbar
Could not set the document.
invalid_document

If I run:

docker build -t earthstar-project/earthstar:latest .

With the following Dockerfile:

FROM denoland/deno:alpine-1.25.4

RUN deno install \
  --allow-read \
  --allow-write \
  --allow-net \
  --allow-run \
  --allow-env \
  --no-check \
  --unstable \
  -f \
  --location https://earthstar-project.org \
  -n earthstar \
  https://deno.land/x/earthstar_cli/src/main.ts

Then I'm basically good to go to have an image which I can use to package for Co-op Cloud.

The thing to figure out in this issue is how to publish these images as the CLI changes.

It would be best if you would consider publishing yourselves here from this repo via some CI thingy? Or manually:

docker build -t earthstar-project/earthstar:latest .
docker push earthstar-project/earthstar