From 8824fa191ea72d654188e6c09e1f89fd09cc682d Mon Sep 17 00:00:00 2001 From: Kirill A Kustov <50442676+LLKoder@users.noreply.github.com> Date: Sat, 2 Dec 2023 12:55:18 +1000 Subject: [PATCH 1/2] Create CLI.md --- docs/CLI.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/CLI.md diff --git a/docs/CLI.md b/docs/CLI.md new file mode 100644 index 000000000..170a471a1 --- /dev/null +++ b/docs/CLI.md @@ -0,0 +1,48 @@ +Content +--- + + + +- [Add bookmark](#add-bookmark) + + + +Add bookmark +--- + +To add bookmark with CLI you can use `shiori add`. + +Shiori has flags to add bookmark: `shiori add --help` + +``` +Bookmark the specified URL + +Usage: + shiori add url [flags] + +Flags: + -e, --excerpt string Custom excerpt for this bookmark + -h, --help help for add + --log-archival Log the archival process + -a, --no-archival Save bookmark without creating offline archive + -o, --offline Save bookmark without fetching data from internet + -t, --tags strings Comma-separated tags for this bookmark + -i, --title string Custom title for this bookmark + +Global Flags: + --log-caller logrus report caller or not + --log-level string set logrus loglevel (default "info") + --portable run shiori in portable mode + --storage-directory string path to store shiori data +``` + +Examples: + +Add url: +`shiori add https://example.com` + +Add url with tags: +`shiori add https://example.com -t "example-1,example-2"` + +Add url with custom title: +`shiori add https://example.com --title "example example"` From 5ae0e64e12a1350a11af4931f3441628cd77ab3a Mon Sep 17 00:00:00 2001 From: Kirill A Kustov <50442676+LLKoder@users.noreply.github.com> Date: Sat, 2 Dec 2023 12:57:27 +1000 Subject: [PATCH 2/2] Update index.md --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 295d60024..060793682 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,7 @@ Shiori is a simple bookmarks manager written in Go language. Intended as a simpl - [API](./API.md) (Deprecated) - [APIv1](./APIv1.md) ([What is this?](https://github.com/go-shiori/shiori/issues/640)) - [Contributing](./Contribute.md) +- [Command Line Interface](./CLI.md) - [Configuration](./Configuration.md) - [FAQ](./Frequently-Asked-Question.md) - [Installation](./Installation.md)