Update README with local ingestion and output options

This commit is contained in:
2026-03-13 03:47:23 +00:00
parent 64cdabd2f8
commit 45b5af079c
2 changed files with 36 additions and 10 deletions
+31 -9
View File
@@ -79,7 +79,23 @@ opus --api-url http://localhost:8000 generate --concept "Your idea"
|--------|-------------|--------| |--------|-------------|--------|
| **GitHub** | Fetch from public/private repos | ✅ | | **GitHub** | Fetch from public/private repos | ✅ |
| **S3/MinIO** | S3-compatible object storage | ✅ | | **S3/MinIO** | S3-compatible object storage | ✅ |
| **Local Files** | Direct file input | ✅ | | **Local Files** | Direct file/directory input | ✅ |
### Ingestion CLI Commands
```bash
# Ingest from GitHub
opus ingest --repo owner/repo
# Ingest from S3/MinIO
opus ingest-s3 --bucket my-bucket --prefix notes/
# Ingest from local files/directory
opus ingest-local ./my-notes/
opus ingest-local ./manuscript.txt
opus ingest-local ./folder --extensions md,txt --recursive
opus ingest-local ./notes --summarize --max-length 5000
```
### Deployment ### Deployment
@@ -105,12 +121,16 @@ opus --api-url http://localhost:8000 generate --concept "Your idea"
### CLI Commands ### CLI Commands
```bash ```bash
# Generate manuscript (local, save to file) # Generate manuscript from concept (local)
opus generate --concept "Your story idea" --framework snowflake --words 5000 opus generate --concept "Your story idea" --framework snowflake --words 5000
# Generate from GitHub # Generate from GitHub
opus generate --repo owner/repo --framework hero-journey --words 80000 opus generate --repo owner/repo --framework hero-journey --words 80000
# Generate from local files/directory
opus generate --local ./my-notes/ --framework snowflake --words 5000
opus generate --local ./manuscript.txt --words 5000
# Generate and save to S3/MinIO # Generate and save to S3/MinIO
opus generate --concept "..." --save-s3 my-bucket/manuscripts/ opus generate --concept "..." --save-s3 my-bucket/manuscripts/
opus generate --concept "..." --save-s3 my-bucket/path/ --save-s3-endpoint https://nyc3.digitaloceanspaces.com opus generate --concept "..." --save-s3 my-bucket/path/ --save-s3-endpoint https://nyc3.digitaloceanspaces.com
@@ -119,14 +139,16 @@ opus generate --concept "..." --save-s3 my-bucket/path/ --save-s3-endpoint https
opus generate --concept "..." --save-repo owner/my-manuscripts opus generate --concept "..." --save-repo owner/my-manuscripts
opus generate --concept "..." --save-repo owner/my-manuscripts --save-branch develop --save-commit-msg "New story draft" opus generate --concept "..." --save-repo owner/my-manuscripts --save-branch develop --save-commit-msg "New story draft"
# Generate from S3, save to GitHub # Generate from one source, save to another
opus generate --repo owner/repo --save-repo owner/output-repo opus generate --repo owner/notes --save-s3 output-bucket/manuscripts/
opus generate --local ./notes --save-repo owner/output-repo
# Generate from S3, save to different S3 bucket # Ingest from various sources
opus ingest-s3 --bucket input-bucket --prefix notes/ | opus generate --save-s3 output-bucket/ opus ingest --repo owner/repo
opus ingest-s3 --bucket my-bucket --prefix notes/
# Ingest from S3/MinIO opus ingest-local ./my-notes/
opus ingest-s3 --bucket my-bucket --prefix notes/ --output content.txt opus ingest-local ./folder --extensions md,txt,notes --recursive
opus ingest-local ./notes --summarize --max-length 5000
# Start API server # Start API server
opus serve --port 8000 opus serve --port 8000
+5 -1
View File
@@ -34,6 +34,7 @@ from opus_orchestrator.langgraph_workflow import OpusGraph, run_opus, OpusGraphS
from opus_orchestrator.autogen_critique import CritiqueCrew, create_critique_crew from opus_orchestrator.autogen_critique import CritiqueCrew, create_critique_crew
from opus_orchestrator.utils.github_ingest import GitHubIngestor, create_github_ingestor from opus_orchestrator.utils.github_ingest import GitHubIngestor, create_github_ingestor
from opus_orchestrator.utils.s3_ingest import S3Ingestor, create_s3_ingestor from opus_orchestrator.utils.s3_ingest import S3Ingestor, create_s3_ingestor
from opus_orchestrator.utils.local_ingest import LocalIngestor, create_local_ingestor
from opus_orchestrator.frameworks import StoryFramework from opus_orchestrator.frameworks import StoryFramework
from opus_orchestrator.crews import ( from opus_orchestrator.crews import (
OpusCrew, OpusCrew,
@@ -113,9 +114,12 @@ __all__ = [
"create_critique_crew", "create_critique_crew",
"GitHubIngestor", "GitHubIngestor",
"create_github_ingestor", "create_github_ingestor",
# S3/MinIO (NEW!) # S3/MinIO
"S3Ingestor", "S3Ingestor",
"create_s3_ingestor", "create_s3_ingestor",
# Local Files
"LocalIngestor",
"create_local_ingestor",
] ]
# Import legacy orchestrator for backward compatibility # Import legacy orchestrator for backward compatibility