RescueBox cli Reference

IN Progress **

typer cli

clone rescuebox repo. assume poetry is setup ok.

poetry run typer rb_audio_transcription.main run --help

Commands ---
app_metadata return app_metadata
routes return routes
task_schema return task schema
transcribe Transcribe audio file

poetry run typer rb_audio_transcription.main run routes

[{'task_schema': '/audio/task_schema', 'run_task': '/audio/transcribe', 'short_title': 'audio transcribe', 'order': 0}]

rescuebox exe quick start

Build exe:

• refer rescuebox.spec for pre-requisite dependencies : binaries and data files for python packages

$ poetry run pyinstaller rescuebox.spec

Usage on windows:

> dist\rescuebox\rescuebox.exe audio --help

• app_metadata: return app_metadata
• routes: return routes
• task_schema return task schema
• transcribe Transcribe audio file from given folder

> cd dist\rescuebox
> rescuebox.exe audio app_metadata

> cd dist\rescuebox
> rescuebox.exe audio transcribe src\rb-audio-transcription\tests

Detailed Usage of rescuebox on mac/linux:

$ rescuebox [OPTIONS] COMMAND [ARGS]...

Options:

• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands:

• docs
• fs
• manage

rescuebox docs

Usage:

$ rescuebox docs [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• ask: Ask a question against the docs
• open: Open docs in the browser

rescuebox docs ask

Ask a question against the docs

Usage:

$ rescuebox docs ask [OPTIONS] QUESTION

Arguments:

• QUESTION: Ask a question against the docs [required]

Options:

• --help: Show this message and exit.

rescuebox docs open

Open docs in the browser

Usage:

$ rescuebox docs open [OPTIONS]

Options:

• --help: Show this message and exit.

rescuebox fs

Usage:

$ rescuebox fs [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list-files: List files in a directory
• ls: List files in a directory
• open: Open a file
• open-file: Open a file

rescuebox fs list-files

List files in a directory

Usage:

$ rescuebox fs list-files [OPTIONS] PATH

Arguments:

• PATH: The path to list files from [required]

Options:

• --help: Show this message and exit.

rescuebox fs ls

List files in a directory

Usage:

$ rescuebox fs ls [OPTIONS] PATH

Arguments:

• PATH: The path to list files from [required]

Options:

• --help: Show this message and exit.

rescuebox fs open

Open a file

Usage:

$ rescuebox fs open [OPTIONS] PATH

Arguments:

• PATH: The path to open [required]

Options:

• --help: Show this message and exit.

rescuebox fs open-file

Open a file

Usage:

$ rescuebox fs open-file [OPTIONS] PATH

Arguments:

• PATH: The path to open [required]

Options:

• --help: Show this message and exit.

rescuebox manage

Usage:

$ rescuebox manage [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• info
• list-experimental-plugins
• list-plugins
• ollama-check
• ollama-site

rescuebox manage info

Usage:

$ rescuebox manage info [OPTIONS]

Options:

• --help: Show this message and exit.

rescuebox manage list-experimental-plugins

Usage:

$ rescuebox manage list-experimental-plugins [OPTIONS]

Options:

• --help: Show this message and exit.

rescuebox manage list-plugins

Usage:

$ rescuebox manage list-plugins [OPTIONS]

Options:

• --help: Show this message and exit.

rescuebox manage ollama-check

Usage:

$ rescuebox manage ollama-check [OPTIONS]

Options:

• --help: Show this message and exit.

rescuebox manage ollama-site

Usage:

$ rescuebox manage ollama-site [OPTIONS]

Options:

• --help: Show this message and exit.