Getting Started

Follow the steps below you'll have your first Homey app running in no-time!

1. Install Node.js

Download Node.js from the Node.js website and install it on your computer.

2. Install athom-cli

Open a command line, and install the athom-cli program by running the following command:

$ npm install -g homey

You might need superuser rights to install this package globally (-g).

Additionally, if you install the homey module in your local project, some editors will automatically code-complete your app.

3. Log-in

In the command-line, log in with your account:

$ homey login

4. Create an app

Now create your first app by running:

$ homey app create

Your app's ID should be a reverse domain name. For example, if you're creating an app for https://solarpanels.acme.org, your app ID will be org.acme.solarpanels.

5. Run your project

You are now ready to run your first app:

$ homey app run

Exit your app by pressing CTRL + C.

When using $ homey app run, the App will be removed when Homey is restarted. Run $ homey app run --clean to run the app and erase all previous settings.

Run $ homey app install to keep the app running for a longer time without debugger attached.

If you connect Homey to your computer using USB, and a Homey Development network interface appears, the communication will happen over this USB connection. Windows users should visit Tools > Settings on Athom Developer after running their first app to enable USB support.

Next, read the SDK Guidelines and App Manifest to get started.