bm: open bookmarks and queries from the command line
This package provides a command-line utility that opens bookmarks and queries. Please see the README on GitHub at https://github.com/ExtremaIS/bm-haskell#readme.
[Skip to Readme]
Flags
Automatic Flags
| Name | Description | Default |
|---|---|---|
| write-hie | write .hie files | Disabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- bm-0.1.1.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.1.0.2, 0.1.1.0, 0.2.0.0 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=1.4.6 && <2.2), ansi-wl-pprint (>=0.6.8 && <0.7), base (>=4.12 && <4.19), bm, directory (>=1.3.3 && <1.4), dlist (>=0.8.0.4 && <1.1), filepath (>=1.4.2.1 && <1.5), network-uri (>=2.6.2 && <2.7), optparse-applicative (>=0.14 && <0.18), scientific (>=0.3.6.2 && <0.4), text (>=1.2.3.1 && <2.1), transformers (>=0.5.6.2 && <0.7), typed-process (>=0.2.6 && <0.3), vector (>=0.12.0.1 && <0.14), yaml (>=0.11.2 && <0.12) [details] |
| Tested with | ghc ==8.6.5 || ==8.8.4 || ==8.10.7 || ==9.0.2 || ==9.2.7 || ==9.4.5 || ==9.6.1 |
| License | MIT |
| Copyright | Copyright (c) 2021-2023 Travis Cardwell |
| Author | Travis Cardwell <travis.cardwell@extrema.is> |
| Maintainer | Travis Cardwell <travis.cardwell@extrema.is> |
| Category | Utils |
| Home page | https://github.com/ExtremaIS/bm-haskell#readme |
| Bug tracker | https://github.com/ExtremaIS/bm-haskell/issues |
| Source repo | head: git clone https://github.com/ExtremaIS/bm-haskell.git |
| Uploaded | by TravisCardwell at 2023-04-23T08:24:22Z |
| Distributions | LTSHaskell:0.2.0.0, NixOS:0.2.0.0, Stackage:0.2.0.0 |
| Executables | bm |
| Downloads | 451 total (4 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2023-04-23 [all 1 reports] |
Readme for bm-0.1.1.0
[back to package description]bm
Overview
bm is a utility for opening bookmarks and queries from the command line.
The bookmarks and queries are configured hierarchically in YAML, and they are
referenced using keyword prefixes. It allows you to quickly open bookmarks
and perform search queries in your browser using only your keyboard.
CLI
Requirements
bm is designed to work on any operating system, but it has only been tested
on Linux.
Installation
.deb Package Installation
Check the Releases page for .deb packages.
.rpm Package Installation
Check the Releases page for .rpm packages.
Installation From Hackage
Install bm from Hackage using Cabal as follows:
$ cabal v2-install bm
Installation From Stackage
Install bm from Stackage using Stack as follows:
$ stack install bm
Usage
Bookmarks and search queries are configured using a hierarchy of keywords in a
YAML configuration file. They are selected using keyword prefixes as
command-line arguments. Command-line completion is available for Bash. See
the bm man page for details.
Note that the command used to open bookmarks and queries can be customized in the configuration file. Specifying the command for your specific browser can make links open considerably faster than with the default (generic) command.
Examples
An example configuration file is available in the config directory on
GitHub (example for the latest release: bm.yaml). The following are
example commands using this configuration file.
Open a bookmark link by specifying keywords. The Nix homepage can be opened with the following command:
$ bm nix
The nixpkgs manual can be opened using the following command:
$ bm nix pkgs manual
Keyword prefixes can also be used. The following command also opens the
nixpkgs manual:
$ bm n p m
When more than one keyword has the same prefix, the first is selected. If a selected bookmark does not specify a URL, the first child is processed.
The / keyword defines a bookmark with a URL as well as a query. When no
query is specified, the URL is opened, allowing you to search with suggestions
using the search field. Open a query by specifying keywords followed by the
query.
$ bm / LinearTypes
When multiple query arguments are provided, they are joined with a space.
Project
Links
- Hackage: https://hackage.haskell.org/package/bm
- Stackage: https://www.stackage.org/package/bm
- Flora: https://flora.pm/packages/@hackage/bm
- GitHub: https://github.com/ExtremaIS/bm-haskell
- GitHub Actions CI: https://github.com/ExtremaIS/bm-haskell/actions
Branches
The main branch is reserved for releases. It may be considered stable, and
HEAD is always the latest release.
The develop branch is the primary development branch. It contains changes
that have not yet been released, and it is not necessarily stable.
Hackage revisions are made for metadata changes, such as relaxation of
constraints when new versions of dependencies are released. The bm.cabal
metadata in the main branch may therefore not match that of Hackage. The
bm.cabal metadata in the develop branch may match, unless work is being
done on a new release that contains other changes.
Tags
All releases are tagged in the main branch. Release tags are signed using
the security@extrema.is GPG key.
Contribution
Issues and feature requests are tracked on GitHub: https://github.com/ExtremaIS/bm-haskell/issues
Issues may also be submitted via email to bugs@extrema.is.
License
This project is released under the MIT License as specified in the
LICENSE file.