summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2025-03-06 13:37:00 +0100
committerYuval Adam <_@yuv.al>2025-03-06 13:37:00 +0100
commitca7bb72088d2ec17a2ae78cb5d8259cb2eb225f8 (patch)
tree26ea20f1114ea47f668a75be5e6eab0b9b69d79f /README.md
parent9ee5a1d4273e5f0166b3f44bd6b040602613f140 (diff)
Initial cli and entrypoints
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7524838..f717262 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,44 @@
# Strangeloop
A recursive and self-referential AI agent framework.
+
+## Installation
+
+Run the latest version directly without installation from `uvx`:
+
+```bash
+$ uvx strangeloop
+```
+
+For developers, from within working copy run:
+
+```bash
+$ uv run strangeloop
+```
+
+## CLI Usage
+
+Strangeloop provides a command-line interface with several commands:
+
+```bash
+# Display help
+strangeloop --help
+
+# Print a hello message
+strangeloop hello
+
+# Greet a user
+strangeloop greet [NAME]
+
+# Display information about the environment
+strangeloop info
+strangeloop info --verbose
+
+# Process a file
+strangeloop process FILE_PATH [--output OUTPUT_PATH]
+```
+
+You can also run the CLI directly without installation:
+
+```bash
+python main.py --help