go-shiori/shiori
1
1
Fork 0
mirror of https://github.com/go-shiori/shiori.git synced 2024-12-27 10:14:13 +08:00
Code Issues Projects Releases Packages Wiki Activity

Document search syntax for CLI and Web UI

matclab 2019-09-30 22:03:40 +02:00
parent 2be0ab798d
commit 29aec0eb61
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
Usage.md

@ -65,6 +65,12 @@ Flags:
Use "shiori [command] --help" for more information about a command.
```
### Search syntax
With the `print` command line interface, you can use `-s` flag to submit keywords that will be searched either in url, title, excerpts or cached content.
You may also use `-t` flag to include tags and `-e` flag to exclude tags.
## Using Web Interface
To access web interface run `shiori serve` or start Docker container following tutorial above. If you want to use a different port instead of 8080, you can simply run `shiori serve -p <portnumber>`. Once started you can access the web interface in `http://localhost:8080` or `http://localhost:<portnumber>` if you customized it. You will be greeted with login screen like this :
@ -83,3 +89,6 @@ Once login succeed you will be able to use the web interface. To add the new acc
![Options page](https://raw.githubusercontent.com/go-shiori/shiori/master/docs/screenshots/04-options.png)
The first new account you add will become the owner and it will deactivate the "shiori:gopher" default user automatically.
When searching for bookmarks, you may use `tag:tagname` to include tags and `-tag:tagname` to exclude tags in the search bar.
You can also use tags dialog: to include tags just click on the tag name you want to include, and to exclude use `Alt + Click` on the tag name that you want to exclude.