docs: readme

README.md

@@ -1,3 +1,69 @@
-# cli
+Dreadnode command line interface.
+
+## Installation
+
+### With Poetry:
+
+```bash
+poetry install 
+```
+
+Then enter the poetry shell:
+
+```bash
+poetry shell
+```
+
+### With Docker:
+
+```bash
+docker build -t dreadnode .
+```
+
+and then run:
+
+```bash
+docker run -it dreadnode --help
+```
+
+## Usage
+
+Help menu:
+
+```bash
+dreadnode --help
+```
+
+Authenticate:
+
+```bash
+dreadnode login
+```
+
+Manage server profiles with:
+
+```bash
+# list all profiles
+dreadnode profile list
+
+# switch to a named profile
+dreadnode profile switch <profile_name>
+
+# remove a profile
+dreadnode profile forget <profile_name>
+```
+
+Interact with the Crucible challenges:
+
+```bash
+# list all challenges
+dreadnode challenge list
+
+# download an artifact
+dreadnode challenge artifact <challenge_id> <artifact_name> -o <output_path>
+
+# submit a flag
+dreadnode challenge submit-flag <challenge_id> 'gAAAAA...'
+```
+
 
-Dreadnode CLI

dreadnode_cli/cli.py

@@ -6,7 +6,6 @@
 from rich import print
 
 from dreadnode_cli import api
-from dreadnode_cli.agent import cli as agent_cli
 from dreadnode_cli.challenge import cli as challenge_cli
 from dreadnode_cli.config import ServerConfig, UserConfig
 from dreadnode_cli.defaults import MAIN_PROFILE_NAME, PLATFORM_BASE_URL
@@ -16,7 +15,7 @@
 
 cli.add_typer(profile_cli, name="profile", help="Manage server profiles")
 cli.add_typer(challenge_cli, name="challenge", help="Crucible challenges")
-cli.add_typer(agent_cli, name="agent", help="Manage agents")
+# cli.add_typer(agent_cli, name="agent", help="Manage agents")
 
 
 @cli.command(help="Authenticate to the platform.")