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
73 changes: 39 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,36 @@ session.complete()
# See examples/teleop_cancel.py for cancellation handling
```

### CLI Usage

Track USB copy operations from the command line.

**For complete examples, see [examples/cli/usb_copy/](examples/cli/usb_copy/).**

Quick example:

```bash
# Start USB copy session
RUN_ID=$(airoa-lineage-usb-copy start \
--namespace production \
--robot-id hsr001 \
--location weblab \
--repository-hash $(git rev-parse HEAD) \
--repository-uri https://github.com/user/repo.git \
--repository-tag v1.0.0 \
--repository-branch main \
--nominal-start-time "2025-11-26T00:00:00+00:00" \
--nominal-end-time "2025-11-26T05:00:00+00:00")

# Perform your USB copy operation
# ...

# Complete session
airoa-lineage-usb-copy complete --run-id "$RUN_ID"
```

See [docs/cli-usage.md](docs/cli-usage.md) for full CLI reference.

### Data Conversion Tracking

Track data conversion pipelines (e.g., ROS Bag → LeRobot format):
Expand Down Expand Up @@ -164,6 +194,14 @@ print("Conversion completed successfully")

## Documentation

- **[CLI Usage Guide](docs/cli-usage.md)** - Command-line interface reference
- Installation and quick start
- Configuration (file, environment variables, CLI arguments)
- Commands (start, complete, cancel)
- Output modes and exit codes
- Shell script integration examples
- Troubleshooting and common errors

- **[Architecture](docs/architecture.md)** - System design and core components
- TeleopSession, ConversionSession, MarquezClient, Timestamp Utilities
- Event flow and RUNNING events
Expand Down Expand Up @@ -207,40 +245,7 @@ Shows how to track a batch ETL pipeline with input/output datasets.

## Development

### Setup

```bash
# Clone the repository
git clone https://github.com/your-org/airoa-lineage.git
cd airoa-lineage

# Install dependencies including dev tools
uv sync --group dev
```

### Run Tests

```bash
make test
```

### Code Quality

```bash
# Format code
make format

# Run linter and type checker
make lint
```

### Build Package

```bash
uv build
```

See the [Development Guide](docs/development.md) for comprehensive development documentation.
For developers who want to contribute to airoa-lineage, see the [Development Guide](docs/development.md).

## License

Expand Down
Loading