@@ -18,45 +18,39 @@ windows. But launching two distinct profiles will start two entirely separate
1818instances of qutebrowser which can be opened and closed independently.
1919
2020## Usage
21- Create a new profile called "python", edit its ` config.py ` , then launch it :
21+ To create a new profile called "python" and launch it with the python docs open :
2222```
2323$ qbpm new python
24- $ qbpm edit python
2524$ qbpm launch python docs.python.org
26- $ qbpm choose # run dmenu or another launcher to pick a profile
2725```
2826
29- ` qbpm from-session ` can copy the tabs of a [ saved qutebrowser
30- session] ( https://qutebrowser.org/doc/help/commands.html#session-save ) to a new
31- profile. If you have a window full of tabs related to planning a vacation, you
32- could save it to a session called "vacation" using ` :session-save -o vacation `
33- in qutebrowser, then create a new profile with those tabs:
34- ```
35- $ qbpm from-session vacation
36- ```
27+ Note that all arguments after ` qbpm launch PROFILE ` are passed to qutebrowser,
28+ so options can be passed too: ` qbpm launch python --target window pypi.org ` .
3729
38- The default profile directory is ` $XDG_DATA_HOME/qutebrowser-profiles ` , where
39- ` $XDG_DATA_HOME ` is usually ` ~/.local/share ` , but you can create and launch
40- profiles from anywhere using ` --profile-dir ` /` -P ` :
41- ```
42- $ qbpm --profile-dir ~/dev/my-project new qb-profile
43- $ cd ~/dev/my-project
44- $ qbpm -P . launch qb-profile
45- # or
46- $ qutebrowser --basedir qb-profile
47- ```
30+ If you have multiple profiles you can use ` qbpm choose ` to bring up a list of
31+ profiles and select one to launch. Depending on what your system has available
32+ the menu may be ` dmenu ` , ` fuzzel ` , ` fzf ` , an applescript dialog, or one of many
33+ other menu programs qbpm can detect. Any dmenu-compatible menu can be used with
34+ ` --menu ` , e.g. ` qbpm choose --menu 'fuzzel --dmenu' ` . As with ` qbpm launch ` ,
35+ extra arguments are passed to qutebrowser.
36+
37+ Run ` qbpm --help ` to see other available commands.
38+
39+ By default when you create a new profile a ` .desktop ` file is created that
40+ launches the profile. This launcher does not depend on qbpm at all, so if you
41+ want you can run ` qbpm new ` once and keep using the profile without needing
42+ qbpm installed on your system.
4843
4944## Installation
5045If you use Nix, you can install or run qbpm as a [ Nix flake] ( https://nixos.wiki/wiki/Flakes ) .
5146For example, to run qbpm without installing it you can use ` nix run github:pvsr/qbpm -- new my-profile ` .
5247
5348On Arch and derivatives, you can install the AUR package: [ qbpm-git] ( https://aur.archlinux.org/packages/qbpm-git ) .
5449
55- Otherwise you'll need to install from source, directly or using a tool like [ uv] ( https://docs.astral.sh/uv/guides/tools/ ) .
56- Using uv you can run qbpm without installing it using
57- ` uv tool run --with git+https://github.com/pvsr/qbpm qbpm ` , or install to ` ~/.local/bin ` with
58- ` uv tool install --with git+https://github.com/pvsr/qbpm qbpm ` .
59- The downside of a source installation is that the [ man page] ( https://github.com/pvsr/qbpm/blob/main/qbpm.1.scd )
50+ Otherwise you can install directly from PyPI using [ uv] ( https://docs.astral.sh/uv/guides/tools/ ) ,
51+ pip, or your preferred client. With uv it's ` uv tool run qbpm ` to run qbpm
52+ without installing and ` uv tool install qbpm ` to install to ` ~/.local/bin ` .
53+ The downside of going through PyPI is that the [ man page] ( https://github.com/pvsr/qbpm/blob/main/qbpm.1.scd )
6054and shell completions will not be installed automatically.
6155
6256On Linux you can copy [ ` contrib/qbpm.desktop ` ] ( https://raw.githubusercontent.com/pvsr/qbpm/main/contrib/qbpm.desktop )
@@ -66,11 +60,10 @@ to `~/.local/share/applications` to create a qbpm desktop application that runs
6660### MacOS
6761
6862Nix and uv will install qbpm as a command-line application, but if you want a
69- native Mac application you can clone this repository or copy the contents of
70- [ ` contrib/qbpm.platypus ` ] ( https://raw.githubusercontent.com/pvsr/qbpm/main/contrib/qbpm.platypus )
71- to a local file, install [ platypus] ( https://sveinbjorn.org/platypus ) ,
72- and create a qbpm app by running ` platypus -P qbpm.platypus /Applications/qbpm.app ` .
73- That will also make qbpm available as a default browser in ` System Preferences > General > Default web browser ` .
63+ native Mac application you can download [ ` contrib/qbpm.platypus ` ] ( https://raw.githubusercontent.com/pvsr/qbpm/main/contrib/qbpm.platypus ) ,
64+ install [ platypus] ( https://sveinbjorn.org/platypus ) , and create a qbpm app with
65+ ` platypus -P qbpm.platypus /Applications/qbpm.app ` . That will also make qbpm
66+ available as a default browser in ` System Preferences > General > Default web browser ` .
7467
7568Note that there is currently [ a qutebrowser bug] ( https://github.com/qutebrowser/qutebrowser/issues/3719 )
7669that results in unnecessary ` file:///* ` tabs being opened.
0 commit comments