Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,18 @@ pip install oswatcher-plugins

## Usage

Plugins are run via the `runner` CLI against a [neogit](https://github.com/OSWatcher/neogit) branch:
Plugins are run via the `runner` CLI against a single [neogit](https://github.com/OSWatcher/neogit) commit:

```bash
runner <plugin_name> <branch_name>
runner <commit_hash> <plugin_name>
# example:
runner symbols Windows_10_21H2
runner 930b7dc140b50b00c192a9ae7f97174823deb378 SYMBOLS
```

Available plugins: `FILETYPE`, `SYMBOLS`, `WINREG`, `SYSCALLS`, `LINUX_SYMBOLS`
(the name is case-insensitive). Use `runner --help` for the full option list,
including `--force` to rerun a plugin that has already been executed on the commit.

## Requirements

- Python 3.11+
Expand Down
2 changes: 1 addition & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ regipy = "^4.1.1"
jsonschema = "^4.21.1"
pypeln = "^0.4.9"
requests = "^2.31"
# setuptools required for pkg_resources compatibility
# pypeln -> stopit -> pkg_resources (may be missing in some virtual environments)
# setuptools pinned <81 for pkg_resources availability.
# pypeln -> stopit imports pkg_resources at module load, and setuptools 81
# removed it, so an unpinned setuptools breaks `runner` on a fresh install.
# stopit 1.1.2 is the latest release and still carries the import.
# See: https://github.com/glenfant/stopit/issues/32
setuptools = "*"
setuptools = "<81"
gitpython = "^3.1.0"


Expand Down
Loading