Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.rst: add nix docs #6606

Merged
merged 1 commit into from
Jan 19, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 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,48 @@ 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
--------------------------

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>"

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
Loading