Skip to content

Commit

Permalink
README.rst: add nix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DontEatOreo committed Dec 5, 2024
1 parent d9bbe3b commit dfaf072
Showing 1 changed file with 56 additions and 1 deletion.
57 changes: 56 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ Scoop
scoop install gallery-dl
Homebrew
--------

Expand Down Expand Up @@ -174,6 +173,62 @@ This will remove the container after every use so you will always have a fresh e
You can also add an alias to your shell for "gallery-dl" or create a simple bash script and drop it somewhere in your $PATH to act as a shim for this command.

Nix and Home Manager
--------------------------

For Nix users, there are a many of ways of using *gallery-dl*:

Adding *gallery-dl* to your system environment:

.. code:: nix
environment.systemPackages = with pkgs; [
gallery-dl
];
Using :code:`nix-shell`

.. code:: bash
nix-shell -p gallery-dl
.. code:: bash
nix-shell -p gallery-dl --run "gallery-dl <args>"
Using :code:`nix3-run`

.. code:: bash
nix run nixpkgs#gallery-dl -- <args>
Using :code:`nix profile`

.. code:: bash
nix profile install nixpkgs#gallery-dl
For Home Manager users, you can manage *gallery-dl* declaratively:

.. code:: nix
programs.gallery-dl = {
enable = true;
settings = {
extractor.base-directory = "~/Downloads";
};
};
Alternatively, you can just add it to :code:`home.packages` if you don't want to manage it declaratively:

.. code:: nix
home.packages = with pkgs; [
gallery-dl
];
After making these changes, simply rebuild your configuration and open a new shell to have *gallery-dl* available.

Usage
=====

Expand Down

0 comments on commit dfaf072

Please sign in to comment.