Skip to content

mokny/mokka

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MOKKA

Python runtime and workspace manager

Requirements

  • Python 3.12 or higher

Installation on Linux

curl -sSL https://raw.githubusercontent.com/mokny/mokka/main/shared/install.sh | bash

Using MOKKA

Creating a workspace

Workspaces can contain multiple modules to keep things structured. You need at least one workspace.

mokka workspace create <NAME>

Installing modules

Modules can be any Python script. The only requirement is a well formatted mokka.toml file in the root directory of the module. If you want to make use of MOKKAs internal inter process communication interface, import mokkalib in your python script. The library will be automatically copied while the module installation process. For more information see mokkalib.

Modules can be installed via several ways: Marketplace, URL pointing to a zip file or a GIT reporistory, or via an absolute path.

mokka install <WORKSPACENAME> </PATH/TO/MODULE>

Finding modules on the marketplace

To search for a module on the marketplace, simply type mokka search <SEARCHTERM>. For example mokka search Webinterface. Searchresults will be listed. If you found the module you like to install, type mokka install <WORKSPACE> <IDENT>. Example: mokka install test mweb. This would install the MOKKA webinterface.

Running modules

Modules run as subprocess in mokka. Each module can communicate with other modules that run in MOKKA (see mokkalib).

mokka run <WORKSPACENAME> <MODULEIDENT>

Setting options for a module

Some modules can be configured by setting options. Refer to the module documentation for available options.

mokka setopt <WORKSPACENAME> <MODULEIDENT> <OPTION> <NEWVALUE>

Updating Modules

Especially during developing, updating a mokka module is often helpful. Note: Only Source-Files and Options are updated. If you made changes to dependencies / pip libraries, you need a full reinstall.

mokka update <WORKSPACENAME> <SOURCE>

Examples

Let's assume you want to install and run the Port-Scanner module "pscan", and you have a fresh mokka installation ready. We also assume that you want to name your workspace test

mokka workspace create test
mokka install test pscan
mokka run test pscan

Now the module pscan is running and checking the open ports on your system. To view the output:

mokka log test pscan

Side note: The pscan module has the target-option, so that you can change the scanning target. To change that option you might use this - This is optional:

mokka setopt test pscan target 198.168.0.200

To abort the scan:

mokka kill test pscan

To remove the module:

mokka remove test pscan

Easy. Right?

More information in the WIKI

MOKKA-Wiki

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published