Skip to content

Commit

Permalink
Add Documentation>CLI>Add bookmark (#794)
Browse files Browse the repository at this point in the history
* Create CLI.md

* Update index.md
  • Loading branch information
LLKoder committed Dec 9, 2023
1 parent 0058209 commit 3df4c0b
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
48 changes: 48 additions & 0 deletions docs/CLI.md
@@ -0,0 +1,48 @@
Content
---

<!-- TOC -->

- [Add bookmark](#add-bookmark)

<!-- /TOC -->

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"`
1 change: 1 addition & 0 deletions docs/index.md
Expand Up @@ -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)
Expand Down

0 comments on commit 3df4c0b

Please sign in to comment.