knex: command not found error [Solved]

avatar

Borislav Hadzhiev

Last updated: Mar 20, 2022

banner

Photo from Unsplash

knex: command not found error [Solved] #

Use npx to solve the error "knex: command not found", e.g. npx knex --version and make sure to install the package locally by opening your terminal in the root directory of your project and running npm install knex.

command not found knex

The fastest way to solve the error is to use the npx command.

shell
npx knex --version

You can prefix any knex command with npx to be able to use the command from any directory.

Make sure that knex is in the dependencies object in your package.json file by opening your terminal in the root directory of your project and running:

shell
npm install knex

As an alternative to prefixing with npx, you can install the knex package globally.

shell
# 👇️ installs knex globally (can run from any directory) npm install -g knex
If the global installation of knex fails, you might have to run the command prefixed with sudo.
shell
sudo npm install -g knex

You can link your project to the globally installed knex package, by opening your terminal in your project's root directory (where your package.json file is) and running the npm link knex command.

shell
npm link knex

The npm link command creates a symbolic link from the globally installed package to the node_modules/ directory of the current folder.

If the "knex: command not found" error is not resolved, try restarting your terminal.

If that doesn't help, run the following command:

shell
npm config get prefix

The command will show you the path where npm puts your globally installed packages. The global packages will be in the bin directory at the specified path.

Look at the PATH environment variable on your operating system and add the path that the npm config get prefix command outputs if it's not already there.

If you add the output from the command to your PATH environment variable, you have to restart any open command prompts before it takes effect.

If that didn't work, try to add the path to the bin folder (from npm config get prefix) to your PATH environment variable and restart your terminal.

For example, on macOS, you can update your path with the following command:

shell
# make sure path matches with npm config get prefix export PATH=/usr/local/share/npm/bin:$PATH

And on Windows, the output of the npm config get prefix command will look something like: C:\Users\Your_User_Name\AppData\Roaming\npm.

Edit the environment variable on your machine and add the specified path (replacing the placeholder with your username).

If you are on Linux, you can add the output from the npm config get prefix command to your .bashrc file.

~/.bashrc
# 👇️ make sure to update the path with the output # from the command export PATH="/usr/local/share/npm/bin:$PATH"
If you add the output from the command to your PATH environment variable, you have to restart any open command prompts before it takes effect.

If that doesn't help try to reinstall Node.js on your machine and then install knex globally by running npm install -g knex.

During the installation, you might get a prompt for whether you want to automatically update the PATH environment variable on your system, make sure to tick the option.
shell
# 👇️ installs knex globally (can run from any directory) npm install -g knex knex --version
If the global installation of knex fails, you might have to run the command prefixed with sudo.
shell
# 👇️ if you get permissions error sudo npm install -g knex knex --version

Alternatively, you can see how you can fix the permissions error on this page in the official npm docs.

Conclusion #

Use npx to solve the error "knex: command not found", e.g. npx knex --version and make sure to install the package locally by opening your terminal in the root directory of your project and running npm install knex.

I wrote a book in which I share everything I know about how to become a better, more efficient programmer.
book cover
You can use the search field on my Home Page to filter through all of my articles.