docs(agentstack-cli): document adding agent from github (#1767)

* docs(agentstack-cli): document adding agent from github

Signed-off-by: Jan Pokorný <[email protected]>

* docs: add --dockerfile docs

Signed-off-by: Jan Pokorný <[email protected]>

---------

Signed-off-by: Jan Pokorný <[email protected]>

Author: JanPokorny

apps/agentstack-cli/src/agentstack_cli/commands/agent.py

@@ -159,7 +159,22 @@ async def add_agent(
     verbose: typing.Annotated[bool, typer.Option("-v", "--verbose", help="Show verbose output")] = False,
     yes: typing.Annotated[bool, typer.Option("--yes", "-y", help="Skip confirmation prompts.")] = False,
 ) -> None:
-    """Add a docker image or GitHub repository [aliases: install]"""
+    """Add a docker image or GitHub repository.
+
+    This command supports a variety of GitHub URL formats for deploying agents:
+
+    - **Basic URL**: `https://github.com/myorg/myrepo`
+    - **Git Protocol URL**: `git+https://github.com/myorg/myrepo`
+    - **URL with .git suffix**: `https://github.com/myorg/myrepo.git`
+    - **URL with Version Tag**: `https://github.com/myorg/[email protected]`
+    - **URL with Branch Name**: `https://github.com/myorg/myrepo@my-branch`
+    - **URL with Subfolder Path**: `https://github.com/myorg/myrepo#path=/path/to/agent`
+    - **Combined Formats**: `https://github.com/myorg/[email protected]#path=/path/to/agent`
+    - **Enterprise GitHub**: `https://github.mycompany.com/myorg/myrepo`
+    - **With a custom Dockerfile location**: `agentstack add --dockerfile /my-agent/path/to/Dockerfile "https://github.com/my-org/my-awesome-agents@main#path=/my-agent"`
+
+    [aliases: install]
+    """
     if location is None:
         repo_input = (
             await inquirer.text(  # pyright: ignore[reportPrivateImportUsage]

docs/development/deploy-agents/deploy-your-agents.mdx

@@ -77,6 +77,39 @@ This automatically:
 **Why "copy into VM"?** Agent Stack runs in an isolated VM (Lima on Mac/Linux, WSL on Windows). Even though Docker Desktop builds your image, Agent Stack needs it copied into its VM to run it. The `add` command handles this automatically.
 </Note>
 
+<Accordion title="Deploying from a GitHub Repository">
+You can also deploy an agent directly from a GitHub repository. The `agentstack add` command supports various URL formats to specify the repository, version, and location of your agent's code.
+
+The supported formats include:
+- **Basic URL**: `https://github.com/myorg/myrepo`
+- **Git Protocol URL**: `git+https://github.com/myorg/myrepo`
+- **URL with .git suffix**: `https://github.com/myorg/myrepo.git`
+- **URL with Version Tag**: `https://github.com/myorg/[email protected]`
+- **URL with Branch Name**: `https://github.com/myorg/myrepo@my-branch`
+- **URL with Subfolder Path**: `https://github.com/myorg/myrepo#path=/path/to/agent`
+- **Combined Formats**: `https://github.com/myorg/[email protected]#path=/path/to/agent`
+- **Enterprise GitHub**: `https://github.mycompany.com/myorg/myrepo`
+
+#### Example
+
+To deploy an agent from a specific branch and subfolder, you would run:
+```bash
+agentstack add "https://github.com/my-org/my-awesome-agents@main#path=/my-agent"
+```
+
+This command tells Agent Stack to:
+1. Fetch the `main` branch of the `my-awesome-agents` repository.
+2. Look for the agent's `Dockerfile` and source code in the `/my-agent` directory.
+3. Build the Docker image and register it with the platform.
+
+
+#### Example with `--dockerfile`
+
+```bash
+agentstack add --dockerfile /my-agent/path/to/Dockerfile "https://github.com/my-org/my-awesome-agents@main#path=/my-agent"
+```
+</Accordion>
+
 ### Verify Deployment
 
 Check that your agent is registered: