To install the Rookout SDK and start debugging your project, follow this quick start guide.
You can also check out our pre-configured example projects over here.
1. Sign Up
Sign up to Rookout.
2. Install the SDK
Install the Rookout SDK (aka 'Rook') by following these steps:
# Install the Rookout pypi package
pip install rook
# Import the package in your app's entry-point file, just before it starts
# Note! if you are using a pre-forking server such as uWSGI, Gunicorn or Celery, be sure to check out
# the Pre-forking servers section in our SDK Setup page
if __name__ == "__main__":
rook.start(token='[Your Rookout Token]')
# Your program starts here :)
// Install the npm package
npm install --save rookout
// Require the package in your app's entry-point file
const rook = require('rookout');
token: '[Your Rookout Token]'
# Download our java agent
curl -L "https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.rookout&a=rook&v=LATEST" -o rook.jar
# Export your token as an environment variable
export ROOKOUT_TOKEN=[Your Rookout Token]
# Set your JVM to use the rook as a java agent
3. Create a Project
Log in to the Rookout IDE and create a new Project. Give it a meaningful name.
Load your Source Code into the Rookout IDE from either Github or from your local file system.
4. Add a Breakpoint
Add a Breakpoint at the line of code you wish to debug, just as if you were adding a Breakpoint in your own IDE.
Run your app and trigger the code you are trying to debug.
5. Watch the Debug Message
Watch the Debug Message in the Rookout IDE.
And that's it, you're done :)