Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation>CLI>Add bookmark #794

Merged
merged 2 commits into from Dec 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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