What is Silk?
How to get started?
First off you need to install the Silk Command Line Interface, with which you will be able to push your Silk programs to the device or emulator.
Install Silk CLI by running
npm install -g silk-cli
Silk ROMs for devices
If you have one of the devices supported by Silk, you can flash it with a Silk rom. See Compatibility and Roms to find out what devices we support and links to download ROMs for them.
If you don't have a compatible device, you can still run Silk using our emulator.
npm install -g silk-emulator
All you have to do then is create a new program with the Silk CLI by running
silk init <program_name>
It will create a new node package you can start hacking on immediately. Here's the full list of Silk commands that you can use with the CLI: Silk Command Line Interface Reference.
We offer a robust set of API you can use in your Silk program. Check them all out: Silk API reference.
Also don't forget to check out the links in the
Resources of this page for all the code examples you can try right away.
Push code to Silk, see it live
Done with the code? Time to try your code. Simply push your program to the device/emulator.
First make sure it's connected:
And if it shows up, just type
You're now good to go, if you've done everything correctly, your program should be up and running!
Silk is updated on a regular basis, make sure to check out the Release notes
Nice to hear you want to help! If you are interested in fixing issues and contributing directly to the code base, please see the document How to the contribute.
If you like, you can build Silk from the source we offer. It also helps to start here if you are planning to port Silk to a device. Head out to Building instructions for Linux and OS X, or for Windows (using a Virtual Machine).
- All about Downloading and Installing Silk
- Quick start with Silk
- Silk Command Line Interface Reference
- Silk APIs reference
Examples to follow:
FAQ and Feedback
- Ask a question, request a feature, bring us feedback or check the FAQ in our forums
- File a bug in GitHub Issues
Silk is still in its early stages and constantly evolving. Don't grow attached to the current APIs. They will likely change and there will be bugs.
MIT License. See LICENSE for full text.
Files reused from other 3rd party projects may be licensed under other Open Source licenses. Please refer to individual files for details.