v3-docs/docs/about/install.md
You need to install the Meteor command line tool to create, run, and manage your Meteor.js projects. Check the prerequisites and follow the installation process below.
npx meteor
To create your meteor project you can run:
meteor create
And it will prompt you to choose a project name and frontend framework.
Install the latest official version of Meteor.js from your terminal by running one of the commands below. You can check our changelog for the release notes.
For Windows, Linux and OS X, you can run the following command:
npx meteor
::: tip
If you get an error with the installation npx you can try running npx clear-npx-cache
or rm -rf ~/.npm/_npx
if the error persists, please try to install Meteor using npm:
npm install -g meteor --foreground-script
Make sure you have Node.js v20 or higher installed.
:::
An alternative for Linux and OS X, is to install Meteor by using curl:
curl https://install.meteor.com/ | sh
You can also install a specific Meteor.js version by using curl:
curl https://install.meteor.com/\?release\=2.8 | sh
Do not install the npm Meteor Tool in your project's package.json. This library is just an installer.
If your user doesn't have permission to install global binaries, and you need to use sudo, it's necessary to append --unsafe-perm to the above command:
sudo npm install -g meteor --unsafe-perm
We strongly discourage the usage of Node.js or Meteor with root permissions. Only run the above command with sudo if you know what you are doing.
If you only use sudo because of a distribution default permission system, check this link for fixing it.
In some cases you can get this error npm WARN checkPermissions Missing write access to /usr/local/lib/node_modules because your Node.js installation was performed with wrong permissions. An easy way to fix this is to install Node.js using nvm and forcing it to be used in your terminal. You can force it in the current session of your terminal by running nvm use 14.
By default, the Meteor installer adds its install path (by default, ~/.meteor/) to your PATH by updating either your .bashrc, .bash_profile, or .zshrc as appropriate. To disable this behavior, install Meteor by running:
npm install -g meteor --ignore-meteor-setup-exec-path --foreground-script
(or by setting the environment variable npm_config_ignore_meteor_setup_exec_path=true)
For Apple M1 computers, you can append Rosetta prefix as following, if you need to run older versions of Meteor (before 2.5.1):
arch -x86_64 npm install -g meteor
or select Terminal in the Applications folder, press CMD(⌘)+I and check the "Open using Rosetta" option.
You can also use a Docker container for running Meteor inside your CI, or even in your local development toolchain.
We do provide the meteor/meteor-base ubuntu-based Docker image, that comes pre-bundled with Node.JS and Meteor, and runs it as a local user (not as root).
You can refer to our meteor/galaxy-images repository to see how to use it, and the latest version. More about meteor-base here.
On Windows, the installer runs faster when Windows Developer Mode is enabled. The installation extracts a large number of small files, which Windows Defender can cause to be very slow.
If you use a node version manager that uses a separate global node_modules folder for each Node version, you will need to re-install the meteor npm package when changing to a Node version for the first time. Otherwise, the meteor command will no longer be found.
To be able to use the meteor command from fish it's needed to include /home/<user>/.meteor in $PATH; to do that just add this line in /home/<user>/.config/fish/config.fish file (replace <user> with your username):
set PATH /home/<user>/.meteor $PATH
Meteor docs ships with llms.txt file, which helps language models use your website
If you have LM Studio installed or any other LLM tool, you can use the llms.txt file to ask questions about Meteor.
curl https://docs.meteor.com/llms-full.txt -o meteor-docs.txt
Then, you can use the file with your LLM tool of choice. For example, if you have LM Studio installed, you can use their chat with documents feature to ask questions about Meteor.
If you installed Meteor using npx, you can remove it by running:
npx meteor uninstall
If you installed Meteor using curl or as a fallback solution, run:
rm -rf ~/.meteor
sudo rm /usr/local/bin/meteor