Metadata-Version: 2.4
Name: shakenfist_agent
Version: 1.0.1
Summary: The in-guest agent for ShakenFist instances
Project-URL: Homepage, https://shakenfist.com
Project-URL: Bug Tracker, https://github.com/shakenfist/agent-python/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: click>=8.0.0
Requires-Dist: distro
Requires-Dist: psutil>5.9.0
Requires-Dist: symbolicmode>=2.0
Requires-Dist: setproctitle
Requires-Dist: protobuf<6,>=5.29.0
Requires-Dist: grpcio>=1.70.0
Requires-Dist: grpcio-status>=1.70.0
Requires-Dist: grpcio-tools>=1.70.0
Requires-Dist: googleapis-common-protos>=1.70.0
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: testtools<2.8.0; extra == "test"
Requires-Dist: mock; extra == "test"
Requires-Dist: stestr; extra == "test"
Requires-Dist: tox; extra == "test"
Requires-Dist: flake8; extra == "test"
Dynamic: license-file

Python side channel agent for Shaken Fist
=========================================

This is the in-guest side channel agent for
[Shaken Fist](https://github.com/shakenfist/shakenfist). It runs
inside virtual machines and provides a vsock-based interface for
the hypervisor to execute commands, transfer files, and gather
system information.

## Documentation

- [docs/index.md](docs/index.md) -- overview and feature summary
- [docs/protocol.md](docs/protocol.md) -- protobuf protocol
  reference
- [docs/developer-guide.md](docs/developer-guide.md) -- building,
  testing, and extending the agent

## Quick Start

```bash
pip install shakenfist-agent
sf-agent daemon run
```

## Development

```bash
# Run unit tests
tox -epy3

# Run linter
tox -eflake8

# Generate coverage report
tox -ecover
```

See [ARCHITECTURE.md](ARCHITECTURE.md) for the project structure
and [AGENTS.md](AGENTS.md) for AI agent guidance.
