- Node.js v4.x
- Python v2.7.x
- The python.exe must be available at
%SystemDrive%\Python27\python.exe
. If it is installed elsewhere, you can create a symbolic link to the directory containing the python.exe using:mklink /d %SystemDrive%\Python27 D:\elsewhere\Python27
- The python.exe must be available at
You can use either:
- Visual Studio 2013 Update 5 (Express or better) on Windows 7, 8 or 10
- Visual Studio 2015 (Community or better) with Windows 8 or 10
Whichever version you use, ensure that:
- The default installation folder is chosen so the build tools can find it
- Visual C++ support is installed
- A
git
command is in your path - If you have both VS2013 and VS2015 installed set the
GYP_MSVS_VERSION
environment variable to the Visual Studio version (2013
or2015
) you wish to use, e.g.[Environment]::SetEnvironmentVariable("GYP_MSVS_VERSION", "2015", "User")
in PowerShell or set it in Windows advanced system settings control panel.
You can run these commands using Command Prompt, PowerShell or Git Shell via GitHub Desktop. These instructions will assume the use of Bash from Git Shell - if you are using Command Prompt use a backslash instead: i.e. script\build
.
cd C:\
git clone https://github.com/atom/atom/
cd atom
script/build
This will create the Atom application in the out\Atom
folder as well as copy it to a folder named Atom
within Program Files
.
--install-dir
- Creates the final built application in this directory. Example (trailing slash is optional):
./script/build --install-dir Z:\Some\Destination\Directory\
--build-dir
- Build the application in this directory. Example (trailing slash is optional):
./script/build --build-dir Z:\Some\Temporary\Directory\
--no-install
- Skips the installation task after building.--verbose
- Verbose mode. A lot more information output.
No, you can use your existing Git! GitHub Desktop's Git Shell is just easier to set up.
If you prefer using your existing Git installation, make sure git's cmd directory is in your PATH env variable (e.g. C:\Program Files (x86)\Git\cmd
) before you open your PowerShell or Command Prompt.
It is also recommended you open your Command Prompt or PowerShell as Administrator.
If none of this works, do install Github Desktop and use its Git Shell as it makes life easier.
-
node is not recognized
- If you just installed Node.js, you'll need to restart your PowerShell/Command Prompt/Git Shell before the node command is available on your Path.
-
msbuild.exe failed with exit code: 1
- Ensure you have Visual C++ support installed. Go into Add/Remove Programs, select Visual Studio and press Modify and then check the Visual C++ box.
-
script/build
stops with no error or warning shortly after displaying the versions of node, npm and Python- Make sure that the path where you have checked out Atom does not include a space. e.g. use
c:\atom
and notc:\my stuff\atom
- Make sure that the path where you have checked out Atom does not include a space. e.g. use
-
script/build
outputs only the Node.js and Python versions before returning- Try moving the repository to
C:\atom
. Most likely, the path is too long. See issue #2200.
- Try moving the repository to
-
error MSB4025: The project file could not be loaded. Invalid character in the given encoding.
- This can occur because your home directory (
%USERPROFILE%
) has non-ASCII characters in it. This is a bug in gyp which is used to build native Node.js modules and there is no known workaround.
- This can occur because your home directory (
-
'node_modules\.bin\npm' is not recognized as an internal or external command, operable program or batch file.
- This occurs if the previous build left things in a bad state. Run
script\clean
and thenscript\build
again.
- This occurs if the previous build left things in a bad state. Run
-
script/build
stops at installing runas withFailed at the runas@x.y.z install script.
- See the next item.
-
error MSB8020: The build tools for Visual Studio 201? (Platform Toolset = 'v1?0') cannot be found.
- If you're building Atom with Visual Studio 2013 try setting the
GYP_MSVS_VERSION
environment variable to 2013 and thenscript/clean
followed byscript/build
(re-open your command prompt or Powershell window if you set it using the GUI)
- If you're building Atom with Visual Studio 2013 try setting the
-
Other
node-gyp
errors on first build attempt, even though the right Node.js and Python versions are installed.- Do try the build command one more time, as experience shows it often works on second try in many of these cases.
- If all fails, use this search to get a list of reports about build errors on Windows, and see if yours has already been reported.
- If it hasn't, please open a new issue with your Windows version, architecture (x86 or amd64), and a screenshot of your build output, including the Node.js and Python versions.