cleaning up plano cli commands

This commit is contained in:
Salman Paracha 2026-01-14 11:39:18 -08:00
parent c1c808feb2
commit bbb3517511
7 changed files with 1762 additions and 25 deletions

View file

@ -1,15 +1,15 @@
# Contribution
We would love feedback on our [Roadmap](https://github.com/orgs/katanemo/projects/1) and we welcome contributions to **Arch**!
We would love feedback on our [Roadmap](https://github.com/orgs/katanemo/projects/1) and we welcome contributions to **Plano**!
Whether you're fixing bugs, adding new features, improving documentation, or creating tutorials, your help is much appreciated.
## How to Contribute
### 1. Fork the Repository
Fork the repository to create your own version of **Arch**:
Fork the repository to create your own version of **Plano**:
- Navigate to the [Arch GitHub repository](https://github.com/katanemo/arch).
- Navigate to the [Plano GitHub repository](https://github.com/katanemo/plano).
- Click the "Fork" button in the upper right corner.
- This will create a copy of the repository under your GitHub account.
@ -18,8 +18,8 @@ Fork the repository to create your own version of **Arch**:
Once you've forked the repository, clone it to your local machine:
```bash
$ git clone https://github.com/katanemo/arch.git
$ cd arch
$ git clone https://github.com/katanemo/plano.git
$ cd plano
```
### 3. Create a branch
@ -37,13 +37,13 @@ Make your changes in the relevant files. If you're adding new features or fixing
### 5. Test your changes
```bash
cd arch
cd plano
cargo test
```
### 6. Push changes, and create a Pull request
Go back to the original Arch repository, and you should see a "Compare & pull request" button. Click that to submit a Pull Request (PR). In your PR description, clearly explain the changes you made and why they are necessary.
Go back to the original Plano repository, and you should see a "Compare & pull request" button. Click that to submit a Pull Request (PR). In your PR description, clearly explain the changes you made and why they are necessary.
We will review your pull request and provide feedback. Once approved, your contribution will be merged into the main repository!

View file

@ -145,7 +145,7 @@ def stop_docker_container(service=PLANO_DOCKER_NAME):
def start_cli_agent(arch_config_file=None, settings_json="{}"):
"""Start a CLI client connected to Arch."""
"""Start a CLI client connected to Plano."""
with open(arch_config_file, "r") as file:
arch_config = file.read()

View file

@ -74,7 +74,7 @@ def main(ctx, version):
log.info(f"Starting plano cli version: {get_version()}")
if ctx.invoked_subcommand is None:
click.echo("""Arch (The Intelligent Prompt Gateway) CLI""")
click.echo("""Plano (AI-native proxy and dataplane for agentic apps) CLI""")
click.echo(logo)
click.echo(ctx.get_help())
@ -121,16 +121,16 @@ def build():
@click.command()
@click.argument("file", required=False) # Optional file argument
@click.option(
"--path", default=".", help="Path to the directory containing arch_config.yaml"
"--path", default=".", help="Path to the directory containing config.yaml"
)
@click.option(
"--foreground",
default=False,
help="Run Arch in the foreground. Default is False",
help="Run Plano in the foreground. Default is False",
is_flag=True,
)
def up(file, path, foreground):
"""Starts Arch."""
"""Starts Plano."""
# Use the utility function to find config file
arch_config_file = find_config_file(path, file)
@ -270,7 +270,7 @@ def logs(debug, follow):
help="Additional settings as JSON string for the CLI agent.",
)
def cli_agent(type, file, path, settings):
"""Start a CLI agent connected to Arch.
"""Start a CLI agent connected to Plano.
CLI_AGENT: The type of CLI agent to start (currently only 'claude' is supported)
"""
@ -278,7 +278,7 @@ def cli_agent(type, file, path, settings):
# Check if plano docker container is running
archgw_status = docker_container_status(PLANO_DOCKER_NAME)
if archgw_status != "running":
log.error(f"archgw docker container is not running (status: {archgw_status})")
log.error(f"plano docker container is not running (status: {archgw_status})")
log.error("Please start plano using the 'planoai up' command.")
sys.exit(1)

View file

@ -18,7 +18,7 @@ $ cargo test
```
## Local development
- Build docker image for arch gateway. Note this needs to be built once.
- Build docker image for Plano. Note this needs to be built once.
```
$ sh build_filter_image.sh
```
@ -27,9 +27,9 @@ $ cargo test
```
$ cargo build --target wasm32-wasip1 --release
```
- Start envoy with arch_config.yaml and test,
- Start envoy with config.yaml and test,
```
$ docker compose -f docker-compose.dev.yaml up archgw
$ docker compose -f docker-compose.dev.yaml up plano
```
- dev version of docker-compose file uses following files that are mounted inside the container. That means no docker rebuild is needed if any of these files change. Just restart the container and chagne will be picked up,
- envoy.template.yaml

File diff suppressed because it is too large Load diff

View file

@ -18,8 +18,8 @@ start_demo() {
echo ".env file created with OPENAI_API_KEY."
fi
# Step 3: Start Arch
echo "Starting Arch with config.yaml..."
# Step 3: Start Plano
echo "Starting Plano with config.yaml..."
planoai up config.yaml
# Step 4: Start developer services
@ -33,8 +33,8 @@ stop_demo() {
echo "Stopping Network Agent using Docker Compose..."
docker compose down
# Step 2: Stop Arch
echo "Stopping Arch..."
# Step 2: Stop Plano
echo "Stopping Plano..."
planoai down
}

View file

@ -18,8 +18,8 @@ start_demo() {
echo ".env file created with OPENAI_API_KEY."
fi
# Step 3: Start Arch
echo "Starting Arch with config.yaml..."
# Step 3: Start Plano
echo "Starting Plano with config.yaml..."
planoai up config.yaml
# Step 4: Start developer services
@ -33,8 +33,8 @@ stop_demo() {
echo "Stopping Network Agent using Docker Compose..."
docker compose down
# Step 2: Stop Arch
echo "Stopping Arch..."
# Step 2: Stop Plano
echo "Stopping Plano..."
planoai down
}