Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Szymongib/bookmark
Save your favourite URLs from the comfort of your terminal and open them quickly in the browser.
https://github.com/Szymongib/bookmark
bookmarks rust terminal
Last synced: 11 days ago
JSON representation
Save your favourite URLs from the comfort of your terminal and open them quickly in the browser.
- Host: GitHub
- URL: https://github.com/Szymongib/bookmark
- Owner: Szymongib
- License: mit
- Created: 2020-06-13T16:29:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-03T07:04:53.000Z (3 months ago)
- Last Synced: 2024-08-04T07:39:08.494Z (3 months ago)
- Topics: bookmarks, rust, terminal
- Language: Rust
- Homepage:
- Size: 2.5 MB
- Stars: 69
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bookmark
Bookmark allows you to save your favourite URLs without leaving the terminal and then quickly open them in the browser.
## Installation
> **CAUTION:** It is recommended to use released version. Use master version on your own risk. There might be breaking changes or experimental features.
### Released version
Download for Linux:
```bash
wget https://github.com/Szymongib/bookmark/releases/download/v0.1.0/bookmark-linux-amd64
chmod +x bookmark-linux-amd64
sudo mv bookmark-linux-amd64 /usr/local/bin/bookmark
```
Download for Mac OS:
```bash
wget https://github.com/Szymongib/bookmark/releases/download/v0.1.0/bookmark-darwin-amd64
chmod +x bookmark-darwin-amd64
sudo mv bookmark-darwin-amd64 /usr/local/bin/bookmark
```
### Using git and Cargo
```bash
git clone [email protected]:Szymongib/bookmark.git
```
```bash
cd bookmark
```
```bash
cargo install --path .
```
## Usage
> **NOTE:** For correct usage documentation, check documentation from tag for corresponding version.
Example commands:
Add URL:
```bash
bookmark add GitHub https://github.com
```
Enter interactive mode:
```bash
bookmark
```
Use `enter` to open URL in the browser, `q` to quite the interactive mode and `h` to display help panel.
List URLs:
```bash
bookmark ls
```
For complete usage of both the Interactive mode and the Standard mode, checkout [the usage documentation.](./docs/usage.md)
## Migrate to new version
If you used Bookmark in version `v0.0.x` you can import your bookmarks to `v0.1.x`.
To see how to do it, checkout [the documentation.](./docs/import-from-previous-version.md)
## Groups and tags
URLs can be added to groups and labeled with tag. Some groups and tags principles include:
- Every URL can be in a single group.
- Every URL can have multiple tags.
- URL names in scope of one group have to be unique.
Some things to consider when using groups and tags:
- If the group is not specified when **adding** the URL, the `default` group is used.
- If the group is not specified when **listing** URLs, all groups are listed.
- If multiple tags are specified when **listing** URLs, all URLs matching at least one tag are listed.
Use `-g [GROUP_NAME]` flag to add or list URLs from a specified group.
Use `-t [TAG_NAME]` flag/flags to add or list URLs with specified tags.