https://github.com/0xeb/ida-climacros

Create and use macros in IDA's CLIs
https://github.com/0xeb/ida-climacros

Last synced: 3 months ago
JSON representation

Create and use macros in IDA's CLIs

• Host: GitHub
• URL: https://github.com/0xeb/ida-climacros
• Owner: allthingsida
• License: mit
• Created: 2019-04-25T05:44:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-15T19:21:14.000Z (over 1 year ago)
• Last Synced: 2024-07-09T08:37:50.841Z (4 months ago)
• Language: C++
• Size: 847 KB
• Stars: 64
• Watchers: 11
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# What is *climacros*?

CLI macros is a productivity tool that lets you define and use static or dynamic macros in IDA's command line interfaces (Python, IDC, WinDbg, BochDbg, Gdb, etc.).

![Quick introduction](docs/_resources/climacros-vid-1.gif)

# Usage

When installed, *climacros* is always active. It comes with a predetermined set of macros:

![Default macros](docs/_resources/climacros-defaults.png)

To create or edit new macros, simply invoke the macro editor from the "Quick plugins view" window (Ctrl-3).

## Static macros

Static macros get substituted as-is in the CLI. For example the following macro:

![Static macro](docs/_resources/climacros-static-macro-create.png)

Outputs the following when executed:

![Static macro output](docs/_resources/climacros-static-macro-run.png)

## Dynamic macros

It is possible to define dynamic macros that get expanded as a result of evaluating a Python expression that returns a string.

For example, the `idc.here()` command is very useful and can be abbreviated with a shorter macro, say `$!` or `${here}`.

To define a dynamic macro, just surround the its expression with `${` and `}$`.

The long form macro `${here}` for the `idc.here()` expression is defined like this:

![Long form here() macro](docs/_resources/climacros-dynamic-create-here.png)

The short form `$!`:

![Long form here() macro](docs/_resources/climacros-dynamic-list-here.png)

A macro is invoked when it is present in a CLI command:

![Long form here() macro](docs/_resources/climacros-dynamic-run-here.png)

## Inline substitution

You don't have to define macros in order to get expressions expansion in the CLI. If you need a one-off expression expansion in the CLI, just define the expression inline:

```python

fn = "test_${str(sum(range(10)))}$.bin"

```

Or:

```python

v = "${str(1 + 2 + 3 + 4)}$"

```

The expression should always evaluate to a **string**, therefore always remember to `str()` the expression or to format it `"%x" % expr` if it does not return a string.

# Installation

*climacros* is written in C++ with IDA's SDK and therefore it should be deployed like a regular plugin. Copy the plugin binaries to either of those locations:

* `/plugins`

* `%APPDATA%\Hex-Rays/plugins`

Since the plugin uses IDA's SDK and no other OS specific functions, the plugin should be compilable for macOS and Linux just fine. I only provide MS Windows binaries. Please check the [releases page](https://github.com/0xeb/ida-climacros/releases).

The first time you run the plugin, it will be populate with the default macros. If you delete all the macros, you won't get back the default macros unless you delete the following file: `%APPDATA%\Hex-Rays/firstrun.climacros`.