Getting started¶

First thing first, install the CLI using any of these methods.

Standard installation for Microsoft Windows, Linux and macOS is script-based, and it's worth noting these scripts will also create shortcuts. For example, fkn, fknode, and also command-specific shortcuts like fkclean, fkaudit, and so on. These shortcuts are script (SH or PS1) based, and are not created when compiling from source or installing for NixOS.

Standard installation¶

Microsoft Windows¶

Copy and paste the following code in a terminal session.

powershell -c "irm fuckingnode.github.io/install.ps1 | iex"

Linux and macOS¶

Copy and paste the following code in a terminal session.

curl -fsSL fuckingnode.github.io/install.sh | bash

Nix / NixOS¶

Warning

ARM (aarch64-linux) support is available, but NOT tested!

Add the repo to your flake.nix.

inputs = {
    ...
    fuckingnode.url = "github:FuckingNode/FuckingNode";
    ...
};

Then, add this to your system packages:

inputs.fuckingnode.packages."${pkgs.system}".default;

Compile from source¶

For contributors and nerds who clone the entire source just to change one line they don't like, compiling is extremely easy:

Install Deno 2.
Open this project from the root.

You can now either:

Run deno task compile and get the output executable from dist/.
Run deno -A src/main.ts [...commands] from the root.

Note

When compiling from source, you'll get an error because of a missing utility "kbi". You can ignore it, we use it for hashing release binaries.

You've now learnt how to install the CLI.

Next: Configure the CLI - Get the CLI ready for usage.