Welcome to Hackersh

Welcome to Hackersh’s documentation. This documentation is divided into different parts. I recommend that you get started with Installation and then head over to the Quickstart. If you’d rather dive into the internals of Hackersh, check out the API Reference documentation.

Hackersh uses Pythonect as its scripting language. To learn more about Pythonect, visit Pythonect’s Web site <http://www.pythonect.org>

Note

This is the main documentation for the Hackersh project. The contents of this site are automatically generated via Sphinx based on the Python docstrings throughout the code and the reStructuredText documents in the doc/ directory of the git repository. If you find an error in the documentation, please report it in the bug tracker here, or even better, submit a pull request!

User’s Guide

This part of the documentation, which is mostly prose, begins with some background information about Hackersh, then focuses on step-by-step instructions for getting the most out of Hackersh.

• Introduction
  • Philosophy
  • What is Hackersh?
• Installation
  • Installing Hackersh
  • Download the Source
• Quickstart
  • Using the Shell
  • Running Commands
  • Running Components
  • Getting Help
  • Debugging
  • Return Values
  • Conditional Expressions
  • Map, Reduce, and Filter
  • Importing and Exporting Context
  • Writing and Running Scripts
• Development
  • Contributor License Agreement
  • Source Control
  • Adding New Components
  • Building the Docs

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

Note

Until the first stable Hackersh version (1.0.0) is released, we reserve the right to break the API at any time.

• hackersh — Parse and execute Hackersh code

Additional Notes

Design notes, legal information and changelog are here for the interested.

• Hackersh Changelog
• License

Questions? Comments?

comments powered by Disqus