Skip to content

docs: re-sync README CLI reference with current source #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sasmith wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: re-sync README CLI reference with current source #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b47d25c
chore: update cogames mettagrid to 0.26.13
nishu-builder Apr 28, 2026
261f770
docs: re-sync README CLI reference with current source
claude May 2, 2026
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
14 changes: 8 additions & 6 deletions README.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">╭─ Describe ──────────────────────────────────────────────────────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--game</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">TEXT </span> Game whose missions to list or describe. <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">[default: cogs_vs_clips]</span> <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--game</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">TEXT </span> Game whose missions to list or describe. <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">[default: cogsguard]</span> <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--mission</span> <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-m</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">MISSION </span> Mission to describe. <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--cogs</span> <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-c</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">INTEGER </span> Override agent count (requires <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-m</span>). <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--variant</span> <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-v</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">VARIANT </span> Apply variant (requires <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-m</span>, repeatable). <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
Expand All @@ -467,7 +467,7 @@
],
"text/plain": [
"\u001b[2m╭─\u001b[0m\u001b[2m Describe \u001b[0m\u001b[2m─────────────────────────────────────────────────────────────────────────────────────────────────────\u001b[0m\u001b[2m─╮\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-game\u001b[0m \u001b[1mTEXT \u001b[0m Game whose missions to list or describe. \u001b[2m[default: cogs_vs_clips]\u001b[0m \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-game\u001b[0m \u001b[1mTEXT \u001b[0m Game whose missions to list or describe. \u001b[2m[default: cogsguard]\u001b[0m \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-mission\u001b[0m \u001b[1m-m\u001b[0m \u001b[1mMISSION \u001b[0m Mission to describe. \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-cogs\u001b[0m \u001b[1m-c\u001b[0m \u001b[1mINTEGER \u001b[0m Override agent count (requires \u001b[1m-m\u001b[0m). \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-variant\u001b[0m \u001b[1m-v\u001b[0m \u001b[1mVARIANT \u001b[0m Apply variant (requires \u001b[1m-m\u001b[0m, repeatable). \u001b[2m│\u001b[0m\n",
Expand Down Expand Up @@ -1019,7 +1019,7 @@
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">╭─ Game Setup ────────────────────────────────────────────────────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--game</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">GAME </span> Game to play (default: cogs_vs_clips). <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">[default: cogs_vs_clips]</span> <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--game</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">GAME </span> Game to play (default: cogsguard). <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">[default: cogsguard]</span> <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--mission</span> <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-m</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">MISSION</span> Mission to play (run <span style=\"font-weight: bold\">cogames missions</span> to list). <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--variant</span> <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-v</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">VARIANT</span> Apply variant modifier (repeatable). <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--cogs</span> <span style=\"color: #008000; text-decoration-color: #008000; font-weight: bold\">-c</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\">N </span> Number of cogs/agents. <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">[default: (from mission)]</span> <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
Expand All @@ -1028,7 +1028,7 @@
],
"text/plain": [
"\u001b[2m╭─\u001b[0m\u001b[2m Game Setup \u001b[0m\u001b[2m───────────────────────────────────────────────────────────────────────────────────────────────────\u001b[0m\u001b[2m─╮\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-game\u001b[0m \u001b[1mGAME \u001b[0m Game to play (default: cogs_vs_clips). \u001b[2m[default: cogs_vs_clips]\u001b[0m \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-game\u001b[0m \u001b[1mGAME \u001b[0m Game to play (default: cogsguard). \u001b[2m[default: cogsguard]\u001b[0m \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-mission\u001b[0m \u001b[1m-m\u001b[0m \u001b[1mMISSION\u001b[0m Mission to play (run \u001b[1mcogames missions\u001b[0m to list). \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-variant\u001b[0m \u001b[1m-v\u001b[0m \u001b[1mVARIANT\u001b[0m Apply variant modifier (repeatable). \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-cogs\u001b[0m \u001b[1m-c\u001b[0m \u001b[1mN \u001b[0m Number of cogs/agents. \u001b[2m[default: (from mission)]\u001b[0m \u001b[2m│\u001b[0m\n",
Expand Down Expand Up @@ -3937,12 +3937,12 @@
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"> Create a new policy from a template. Requires <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--trainable</span> or <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--scripted</span>. \n",
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"> Create a new policy from a template. Requires exactly one policy type. \n",
" \n",
"</pre>\n"
],
"text/plain": [
" Create a new policy from a template. Requires \u001b[1m-\u001b[0m\u001b[1m-trainable\u001b[0m or \u001b[1m-\u001b[0m\u001b[1m-scripted\u001b[0m. \n",
" Create a new policy from a template. Requires exactly one policy type. \n",
" \n"
]
},
Expand All @@ -3955,13 +3955,15 @@
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">╭─ Policy Type ───────────────────────────────────────────────────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--trainable</span> Create a trainable (neural network) policy. <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--scripted</span> Create a scripted (rule-based) policy. <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span> <span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">--amongthem</span> Create an AmongThem BitWorld scripted practice policy. <span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">│</span>\n",
"<span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[2m╭─\u001b[0m\u001b[2m Policy Type \u001b[0m\u001b[2m──────────────────────────────────────────────────────────────────────────────────────────────────\u001b[0m\u001b[2m─╮\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-trainable\u001b[0m Create a trainable (neural network) policy. \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-scripted\u001b[0m Create a scripted (rule-based) policy. \u001b[2m│\u001b[0m\n",
"\u001b[2m│\u001b[0m \u001b[1m-\u001b[0m\u001b[1m-amongthem\u001b[0m Create an AmongThem BitWorld scripted practice policy. \u001b[2m│\u001b[0m\n",
"\u001b[2m╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"
]
},
Expand Down
Loading