Siphon is primarily a command-line tool. This quickstart tutorial will walk you through the installation process and then describe all of the ways that you can interact with the service.
To get started with Siphon you will need to download our lightweight command-line tool. Paste the following command into a terminal window:
The installer script will take a few seconds to complete. Once that's done, check that the tool is working:
One way to run apps is by installing the Siphon Sandbox app onto your device. Open up your phone's browser and type in the following address if it's an iPhone:
Or, if it's an Android device:
Once that's done, login with your Siphon account. No account yet?
You can also use the siphon play command to run your apps in the simulator. More on that below.
Navigate to a suitable directory (anywhere is fine) and type the following command to create a new app:
You can name the app anything you like. The tool creates a new directory with same name.
The new directory contains a simple React Native template app. Once the command finishes running, the new app is going to appear in the Siphon Sandbox.
Next, tap on the icon to start the app; it's going to load over-the-air.
Now let's try making some changes. Navigate into the newly created directory and open up index.js in your favourite editor.
Change some of the template text within the <Text> tag and save the file.
Next, push your changes with the command-line tool:
The app should now automatically reload on the phone and display your changes. Instead of typing in this command for every change, you can also use the tool to watch your app for changes:
Every time you save a change to one of your app's files, the tool will push those changes automatically. This makes the process of developing your app much more pleasant.
To stream logs and errors from your app as it runs in the sandbox, you can use the siphon logs command.
If you're using a Mac, there's a way to run your app in the iOS simulator. Navigate to your app directory and type in:
The tool will prompt you to install Xcode and any other necessary components that you haven't already installed on your local machine.
It will then build and run your project as a standalone app in the simulator while running the React Native packager in the background (so you get the benefits of Hot Reloading).
You can specify other simulator types like this:
Soon you will also be able to run your app in the Android emulator, but for now you should use the sandbox.
Before publishing an app it can be useful to send it to beta testers so that they can give you feedback. Simply specify an email address and we will send them an invitation to beta test your app:
No approval is required and the recipient will be prompted to create a Siphon account if they do not already have one. The user will see a special read-only copy of your app and you can instantly send them changes as often as you like.
When you're finished working on an app, you can publish it by typing in one command:
You will be prompted to enter some basic information about your app, like a description and some keywords.
Behind-the-scenes we will build, sign, package and submit an app binary on your behalf.