docs: Minor usage cleanup.
Some checks failed
Build Tilde Friends / Build-All (push) Has been cancelled
Some checks failed
Build Tilde Friends / Build-All (push) Has been cancelled
This commit is contained in:
@ -7,8 +7,8 @@ Usage: out/debug/tildefriends command [command-options]
|
||||
commands:
|
||||
run - Run tildefriends (default).
|
||||
sandbox - Run a sandboxed tildefriends sandbox process (used internally).
|
||||
import - Import apps to SSB.
|
||||
export - Export apps from SSB.
|
||||
import - Import apps from file to the database.
|
||||
export - Export apps from the database to file.
|
||||
publish - Append a message to a feed.
|
||||
private - Append a private post message to a feed.
|
||||
create_invite - Create an invite.
|
||||
@ -27,9 +27,11 @@ commands:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends run [options]
|
||||
Usage: out/debug/tildefriends run [options]
|
||||
|
||||
options
|
||||
Run tildefriends (default).
|
||||
|
||||
options:
|
||||
-s, --script script Script to run (default: core/core.js).
|
||||
-d, --db-path path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
-k, --ssb-network-key key SSB network key to use.
|
||||
@ -71,6 +73,8 @@ options
|
||||
|
||||
Usage: out/debug/tildefriends sandbox [options]
|
||||
|
||||
Run a sandboxed tildefriends sandbox process (used internally).
|
||||
|
||||
options:
|
||||
-h, --help Show this usage information.
|
||||
-f, --fd File descriptor with which to communicate with parent process.
|
||||
@ -80,7 +84,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends import [options] [paths...]
|
||||
Usage: out/debug/tildefriends import [options] [paths...]
|
||||
|
||||
Import apps from file to the database.
|
||||
|
||||
options:
|
||||
-u, --user user User into whose account apps will be imported (default: "import").
|
||||
@ -92,7 +98,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends export [options] [paths...]
|
||||
Usage: out/debug/tildefriends export [options] [paths...]
|
||||
|
||||
Export apps from the database to file.
|
||||
|
||||
options:
|
||||
-u, --user user User from whose account apps will be exported (default: "core").
|
||||
@ -106,7 +114,9 @@ paths Paths of apps to export (example: /~core/ssb /~user/a
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends publish [options]
|
||||
Usage: out/debug/tildefriends publish [options]
|
||||
|
||||
Append a message to a feed.
|
||||
|
||||
options:
|
||||
-u, --user user User owning identity with which to publish.
|
||||
@ -120,7 +130,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends private [options]
|
||||
Usage: out/debug/tildefriends private [options]
|
||||
|
||||
Append a private post message to a feed.
|
||||
|
||||
options:
|
||||
-u, --user user User owning identity with which to publish (optional).
|
||||
@ -135,7 +147,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends create_invite [options]
|
||||
Usage: out/debug/tildefriends create_invite [options]
|
||||
|
||||
Create an invite.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -151,7 +165,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends get_sequence [options]
|
||||
Usage: out/debug/tildefriends get_sequence [options]
|
||||
|
||||
Get the last sequence number for a feed.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -163,7 +179,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends get_identity [options]
|
||||
Usage: out/debug/tildefriends get_identity [options]
|
||||
|
||||
Get the server account identity.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -174,7 +192,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends get_profile [options]
|
||||
Usage: out/debug/tildefriends get_profile [options]
|
||||
|
||||
Get profile information for the given identity.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -186,7 +206,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends get_contacts [options]
|
||||
Usage: out/debug/tildefriends get_contacts [options]
|
||||
|
||||
Get information about followed, blocked, and friend identities.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -198,7 +220,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends has_blob [options]
|
||||
Usage: out/debug/tildefriends has_blob [options]
|
||||
|
||||
Check whether a blob is in the blob store.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -210,7 +234,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends get_blob [options]
|
||||
Usage: out/debug/tildefriends get_blob [options]
|
||||
|
||||
Read a file from the blob store.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -223,7 +249,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends store_blob [options]
|
||||
Usage: out/debug/tildefriends store_blob [options]
|
||||
|
||||
Write a file to the blob store.
|
||||
|
||||
options:
|
||||
-d, --db-path db_path SQLite database path (default: /home/cory/.local/share/tildefriends/db.sqlite).
|
||||
@ -235,7 +263,9 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends verify [options]
|
||||
Usage: out/debug/tildefriends verify [options]
|
||||
|
||||
Verify a feed.
|
||||
|
||||
options:
|
||||
-i, --identity identity Identity to verify.
|
||||
@ -248,9 +278,11 @@ options:
|
||||
|
||||
```
|
||||
|
||||
out/debug/tildefriends test [options]
|
||||
Usage: out/debug/tildefriends test [options]
|
||||
|
||||
options
|
||||
Test SSB.
|
||||
|
||||
options:
|
||||
-t, --tests tests Comma-separated list of tests to run. (default: all)
|
||||
-h, --help Show this usage information.
|
||||
```
|
||||
|
Reference in New Issue
Block a user