erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
4,579 commits 2 branches 0 tags 65 MiB
Commit graph libervia-backend/doc/libervia-cli
Author SHA1 Message Date
Goffi
3cf38d138e doc (cli/contacts): Add documentation for contacts: 
describe the new `contacts` commands to handle pubsub contacts.

fix 475
 2026-02-23 13:15:16 +01:00
Goffi
a8ef17c5f8 doc(tor, cli/info): Add documentation on Tor feature: 
- Add `autodoc_pydantic` dependency for `docs`, it renders nicely Pydantic models,
  including the settings.
- Add documentation for `li info tor`
- Add a dedicated section on Tor

fix 473
 2025-12-15 11:44:26 +01:00
Goffi
4346278bd8 doc (cli/call): Update doc with new features: 
Add doc for:

- `no_ui` output
- stdin/stdout redirection
- custom GStreamer pipelines
 2025-11-19 18:03:07 +01:00
Goffi
b816dc5e54 cli (pubsub): List support first draft + doc: 
Basic support for listing hierarchy of nodes with pubsub extended discovery. Nodes are
displayed as a tree, depth can be specified.

rel 463
 2025-08-31 12:34:37 +02:00
Goffi
33edd87271 doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc. 2024-11-20 11:49:46 +01:00
Goffi
c1ed8306ae doc (cli/message): add documentation for new addressing commands: 
rel 450
 2024-09-26 16:12:01 +02:00
Goffi
cf0363a3af doc (cli): documentation for new gateway command: 
rel 449
 2024-09-06 18:03:36 +02:00
Goffi
ba7cec65a0 doc (cli): remote-control documentation 
Document the new remote control commands.

rel 436
 2024-05-11 13:52:43 +02:00
Goffi
672f967080 doc (cli/call): add `tui` output, and document options: 
fix 428
 2024-02-16 18:46:06 +01:00
Goffi
40ababcf9c doc (cli/call): add outputs documentation: 
outputs are now documentated, and notably the new `gui` one.

fix 427
 2024-02-11 23:22:18 +01:00
Goffi
b634e41ac0 core, doc, cli (forums): new forums set commands + doc: 
- document the fact that if an empty `uri` is used, the forum node is created
  automatically
- new `forums/set` CLI commands and its documentation
 2023-12-11 18:10:27 +01:00
Goffi
d80c4e89dc plugin XEP-0277, doc: conflict is now checked and avoided if user_friendly_id_suffix is False, doc updated 2023-12-05 13:39:03 +01:00
Goffi
3c6cd70c80 doc (cli/blog): Document new --alt-link option 2023-12-05 13:14:55 +01:00
Goffi
e3370c0a00 doc (cli/blog): documentation of the new --no-id-suffix option. 2023-12-05 13:13:03 +01:00
Goffi
d96ca8443b doc (cli): documentation for the new call command: 
fix 426
 2023-11-01 14:10:31 +01:00
Goffi
ba3f96672f doc (cli): notification commands documentation. 2023-10-18 15:33:46 +02:00
Goffi
7e3834a5e9 refactoring: fix names in doc following modules hierarchy refactoring 2023-06-02 17:38:37 +02:00
Goffi
6a6f15707a massive refactoring to switch from camelCase to snake_case: 
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.

However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.

To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.

This is a massive change, and may result in some bugs.
 2023-04-08 13:54:42 +02:00
Goffi
d50412c7f7 dpc (cli/info): update "disco" documentation to include new "external services": 
fix 418
 2023-04-07 15:18:39 +02:00
Goffi
dd434fbf1f doc (encryption, cli): document Pubsub Targeted Encryption: 
a small section has been added to `encryption` to explain the difference with OXPS, and
the `--encrypt-for` arguments are explained.

fix 382
 2022-10-31 13:50:12 +01:00
Goffi
289855c9d1 doc (encryption, cli): pubsub signing documentation: 
- add a `Pubsub Signature` section to `encryption` documentation
- document `-X, --sign` flag where it's used
- document `pubsub/signature` subcommands

fix 381
 2022-10-30 01:06:58 +02:00
Goffi
39181f0bff doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling: 
fix 380
 2022-10-15 20:38:33 +02:00
Goffi
b06f5cad04 doc (cli/event): update doc following changes: 
rel 372
 2022-09-22 12:01:44 +02:00
Goffi
4b8e1c2747 doc (cli/pubsub, cli/blog): attachments subcommands documentation: 
rel 370
 2022-07-22 17:16:28 +02:00
Goffi
fa5a0de7f7 doc (cli/blog): repeat documentation: 
rel 370
 2022-07-22 17:15:40 +02:00
Goffi
0938a7cd58 doc (cli/pubsub): add doc for `reference` subcommand: 
rel 369
 2022-07-10 16:15:09 +02:00
Goffi
f9eb48d72d doc (components): AP item retraction + blocking: 
fix 367
 2022-06-17 15:50:34 +02:00
Goffi
daccd1de5d doc (cli/message): retract command 2022-06-17 15:50:15 +02:00
Goffi
60dcb5d396 doc (cli/blocking): blocking command documentation: 
rel 367
 2022-06-17 14:15:23 +02:00
Goffi
f66f602df2 doc (cli/pubsub): document new --public flags: 
`--public` option is documented for `subscribe`, `subscriptions` and `node subscriptions
get`, with examples. A warning has been added to show explicitely the privacy implication
of using `--public` with `subscribe`.

rel 365
 2022-05-13 19:32:06 +02:00
Goffi
aa4e6004e8 doc (components): base documentation for AP Gateway: 
fix: 362
 2021-09-26 16:41:58 +02:00
Goffi
d7d40a6d50 merge bookmark @ 2021-09-26 16:41:49 +02:00
Goffi
8c9af32d56 doc: components documentation: 
rel 362
 2021-09-26 16:38:00 +02:00
Goffi
60526e6849 doc (cli/pubsub_cache): search command documentation: 
rel 361
 2021-09-08 17:58:48 +02:00
Goffi
65f8701648 doc (cli/pubsub_cache): add a warning for reset 2021-09-08 17:58:48 +02:00
Goffi
fe502fc0fc merge branche "@" 2021-08-28 15:32:58 +02:00
Goffi
404a2820cf doc: minor typo 2021-08-27 14:59:47 +02:00
Goffi
bd25717a7d doc (cli/pubsub): document pubsub cache management commands 2021-07-29 22:51:01 +02:00
Goffi
57478c869f doc (cli/pubsub/delete): update doc following notification option change 2021-07-29 22:51:01 +02:00
Goffi
907277e422 doc (cli/pubsub/get): fix option in example: 
`-M` (legacy max items) must be used here to retrieve **last** items
 2021-07-29 22:51:01 +02:00
Goffi
bdfa48220d doc (cli/common): time pattern 2021-07-29 22:51:01 +02:00
Goffi
7f3e7635a9 doc (cli/common): explain the new -C, --no-cache option 2021-07-29 22:51:01 +02:00
Goffi
6c2d81696c doc: fix remaining SàT references/typos + add libervia-cli missing commands 2021-06-11 09:21:41 +02:00
Goffi
bed5aa94a6 doc (cli/profile): add autoconnection in example 2021-06-09 10:04:10 +02:00
Goffi
1ad8de5726 doc: config file is now libervia.conf (even if sat.conf still works, for now) 2021-06-03 15:15:11 +02:00
Goffi
2695a5a15b doc: more renaming 2021-04-22 18:16:19 +02:00
Goffi
6d15e23a31 doc: updated doc following global renaming 2021-03-21 18:23:58 +01:00