Skip to content

RGSofftek/frida-rpa-cli

Repository files navigation

frida-rpa-cli

frida-rpa-cli is a local command-line tool for FRIDA automation teams. It helps you prepare workspaces, lint/fix scripts, and interact with Cognitive resources from one command: frida-rpa.

What This CLI Is For

Use frida-rpa when you want to:

  • prepare a FRIDA workspace quickly (open, agents, status)
  • keep scripts clean and consistent (lint, fix)
  • sync with Cognitive safely (cognitive push, cognitive pull, cognitive logs)
  • generate estimation artifacts (estimate)

If you only need editor syntax features, see the extension section later in this README.

Install (Local Development)

Requirements:

  • Node.js + npm
  • Python (for some lint/estimation tooling)

From the repository root:

npm install
npm run compile
npm link

Verify installation:

frida-rpa --help

Naming:

  • npm package: frida-rpa-cli
  • installed command: frida-rpa
  • legacy alias kept for compatibility: frida-work (deprecated)

Quick Start

One-time setup:

frida-rpa login

Typical day-to-day flow:

frida-rpa status
frida-rpa lint
frida-rpa fix
frida-rpa cognitive push

To pull latest remote Actions.txt before editing:

frida-rpa cognitive pull --backup

Command Overview

Workspace Setup

  • frida-rpa open [path]
    Prepare FRIDA settings and open the workspace in your editor.
  • frida-rpa status [path] [--json]
    Show detected process/step context and auth/session status.
  • frida-rpa agents [path]
    Import AGENTS.md and agent-docs helper context into a workspace.

Useful open flags:

  • --editor <code|cursor>
  • --patterns "<csv-globs>"
  • --settings-source "<path>"
  • --settings-mode <merge|replace>
  • --dry-run
  • --no-dev-host

Script Quality

  • frida-rpa lint [path]
    Run lint checks without modifying files.
  • frida-rpa lint info (alias: lint rules)
    Print lint rule catalog.
  • frida-rpa fix [path]
    Run format + safe fixes + final verification.

Useful flags:

  • --json
  • --unsafe-fixes (applies behavior-changing auto-fixes)
  • --process-id <n>
  • --step <n>

Cognitive Cloud

Canonical commands:

  • frida-rpa cognitive login
  • frida-rpa cognitive logout
  • frida-rpa cognitive apps list
  • frida-rpa cognitive suites list --app <id>
  • frida-rpa cognitive processes list [--suite <id>]
  • frida-rpa cognitive logs latest --process-id <id>
  • frida-rpa cognitive push
  • frida-rpa cognitive pull --backup
  • frida-rpa cognitive nav (interactive navigator)

Notes:

  • top-level frida-rpa push and frida-rpa pull still work, but are deprecated aliases
  • top-level frida-rpa logs is removed; use frida-rpa cognitive logs ...

Estimation

The estimate command group generates estimation files (JSON + PPTX).

Install estimation dependencies:

python -m pip install -r estimation/requirements.txt

Common usage:

frida-rpa estimate init
frida-rpa estimate example
frida-rpa estimate generate --config ./estimation_mock.json

Interactive Shell

Running frida-rpa with no command opens an interactive shell:

frida-rpa

Inside the shell:

  • use help for commands
  • use exit or quit to leave

Troubleshooting

npm compile does not work

Use:

npm run compile

(compile is a package script, so it must be called with npm run.)

npm link fails with EEXIST

A stale global shim already exists (often from previous installs/renames).
Remove old shims in your npm global bin folder (for example frida-rpa, frida-work) and run npm link again.

push is blocked

cognitive push has safety checks and can block on remote drift.
When blocked, first sync/inspect with cognitive pull --backup or use --force only when you intentionally want local overwrite behavior.

Full Help

frida-rpa --help
frida-rpa help open
frida-rpa help lint
frida-rpa help cognitive
frida-rpa help estimate

VS Code/Cursor Extension Notes

This repository also contains the FRIDA editor extension (language id frida) with:

  • syntax highlighting and snippets
  • language config (## comments, #%region folding, bracket/quote pairing)
  • completion/hover support from resources/frida.completion.json

File Association

The extension does not claim all .txt files automatically. In your FRIDA workspace .vscode/settings.json, set frida.filePatterns:

{
  "frida.filePatterns": [
    "**/Actions.txt",
    "**/*SAPStatus*.txt"
  ]
}

Optional explicit association:

{
  "files.associations": {
    "**/Actions.txt": "frida"
  }
}

Extension Build/Test

npm test
npm run test:ts
npm run test:py
npm run vscode:prepublish
npx @vscode/vsce package

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors