This commit is contained in:
Niccolo Borgioli 2023-05-25 19:06:07 +02:00
parent 83b2fa5372
commit ac68f4a540
No known key found for this signature in database
GPG Key ID: D93C615F75EE4F0B
3 changed files with 75 additions and 8 deletions

View File

@ -18,7 +18,8 @@ EN | [简体中文](README_zh-CN.md)
## About? ## About?
_cryptgeon_ is a secure, open source sharing note or file service inspired by [_PrivNote_](https://privnote.com) _cryptgeon_ is a secure, open source sharing note or file service inspired by [_PrivNote_](https://privnote.com).
It includes a server, a web page and a CLI client.
> 🌍 If you want to translate the project feel free to reach out to me. > 🌍 If you want to translate the project feel free to reach out to me.
> >
@ -26,10 +27,21 @@ _cryptgeon_ is a secure, open source sharing note or file service inspired by [_
## Live Service / Demo ## Live Service / Demo
### Web
Check out the live service / demo and see for yourself [cryptgeon.org](https://cryptgeon.org) Check out the live service / demo and see for yourself [cryptgeon.org](https://cryptgeon.org)
### CLI
```
npx cryptgeon send text "This is a secret note"
```
For more documentation about the CLI see the [readme](./packages/cli/README.md).
## Features ## Features
- send text or files
- server cannot decrypt contents due to client side encryption - server cannot decrypt contents due to client side encryption
- view or time constraints - view or time constraints
- in memory, no persistence - in memory, no persistence
@ -121,14 +133,13 @@ There is a [guide](https://mariushosting.com/how-to-install-cryptgeon-on-your-sy
**Requirements** **Requirements**
- `pnpm`: `>=6` - `pnpm`: `>=6`
- `node`: `>=16` - `node`: `>=18`
- `rust`: edition `2021` - `rust`: edition `2021`
**Install** **Install**
```bash ```bash
pnpm install pnpm install
pnpm --prefix frontend install
# Also you need cargo watch if you don't already have it installed. # Also you need cargo watch if you don't already have it installed.
# https://lib.rs/crates/cargo-watch # https://lib.rs/crates/cargo-watch
@ -148,6 +159,7 @@ Running `pnpm run dev` in the root folder will start the following things:
- redis docker container - redis docker container
- rust backend - rust backend
- client - client
- cli
You can see the app under [localhost:1234](http://localhost:1234). You can see the app under [localhost:1234](http://localhost:1234).
@ -157,10 +169,7 @@ Tests are end to end tests written with Playwright.
```sh ```sh
pnpm run test:prepare pnpm run test:prepare
docker compose up redis -d
pnpm run test:server
# In another terminal.
# Use the test or test:local script. The local version only runs in one browser for quicker development. # Use the test or test:local script. The local version only runs in one browser for quicker development.
pnpm run test:local pnpm run test:local
``` ```
@ -169,7 +178,9 @@ pnpm run test:local
Please refer to the security section [here](./SECURITY.md). Please refer to the security section [here](./SECURITY.md).
###### Attributions ---
_Attributions_
- Test data: - Test data:
- Text for tests [Nietzsche Ipsum](https://nietzsche-ipsum.com/) - Text for tests [Nietzsche Ipsum](https://nietzsche-ipsum.com/)

54
packages/cli/README.md Normal file
View File

@ -0,0 +1,54 @@
# Cryptgeon CLI
The CLI is a functionally identical way to interact with cryptgeon notes.
It supports text, files, expiration, password, etc.
## Installation
```bash
npx cryptgeon
# Or install globally
npm -g install cryptgeon
cryptgeon
```
## Examples
```bash
# Create simple note
cryptgeon send text "Foo bar"
# Send two files
cryptgeon send file my.pdf picture.png
# 3 views
cryptgeon send text "My message" --views 3
# 10 minutes
cryptgeon send text "My message" --minutes 10
# Custom password
cryptgeon send text "My message" --password "1337"
# Password from stdin
echo "1337" | cryptgeon send text "My message"
# Open a link
cryptgeon open https://cryptgeon.org/note/16gOIkxWjCxYNuXM8tCqMUzl...
```
## Options
### Custom server
The default server is `cryptgeon.org`, however you can use any cryptgeon server by passing the `-s` or `--server` option, or by setting the `CRYPTGEON_SERVER` environment variable.
### Password
Optionally, just like in the web ui, you can choose to use a manual password. You can do that by passing the `-p` or `--password` options, or by piping it into stdin.
```bash
echo "my pw" | cryptgeon send text "my text"
cat pass.txt | cryptgeon send text "my text"
```

View File

@ -42,6 +42,7 @@ program.name('cryptgeon').version(version).configureHelp({ showGlobalOptions: tr
program program
.command('info') .command('info')
.description('show information about the server')
.addOption(server) .addOption(server)
.action(async (options) => { .action(async (options) => {
setBase(options.server) setBase(options.server)
@ -56,7 +57,7 @@ program
console.table(formatted) console.table(formatted)
}) })
const send = program.command('send') const send = program.command('send').description('send a note')
send send
.command('file') .command('file')
.addArgument(files) .addArgument(files)
@ -86,6 +87,7 @@ send
program program
.command('open') .command('open')
.description('open a link with text or files inside')
.addArgument(url) .addArgument(url)
.addOption(password) .addOption(password)
.addOption(all) .addOption(all)