Skip to content

Update Aerie -> PlanDev in README #183

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

Merged
dandelany merged 5 commits into from
Jan 15, 2026
Merged

Update Aerie -> PlanDev in README #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d0b09f7
Merge pull request #174 from NASA-AMMOS/release/v2.10.2
cartermak Sep 16, 2025
2df652e
Merge branch 'main' into release/v2.11.0
Dec 1, 2025
5656254
Set version to 2.11.0.
Dec 1, 2025
a682ee7
Merge pull request #179 from NASA-AMMOS/release/v2.11.0
parkerabercrombie Dec 1, 2025
9253bb8
update README to change references to Aerie -> PlanDev
dandelany Jan 9, 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
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ jobs:
python -m pip install --upgrade pip
pip install pytest
pip install .
- name: Set up instance of Aerie ${{ matrix.aerie-version }}
- name: Set up instance of PlanDev ${{ matrix.aerie-version }}
env:
DOCKER_TAG: v${{ matrix.aerie-version }} # Prefix 'v' used in Aerie Docker image tags
DOCKER_TAG: v${{ matrix.aerie-version }} # Prefix 'v' used in PlanDev Docker image tags
run: |
docker compose -f docker-compose-test.yml up -d
docker images
Expand Down
74 changes: 44 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
# Aerie-CLI

Aerie-CLI provides a command-line interface and user-extendable Python API for interacting with an instance of Aerie.
Aerie-CLI provides a command-line interface and user-extendable Python API for interacting with an instance of PlanDev.

> Note: this project is an informal CLI and is _not_ maintained by the MPSA Aerie team.
> Note: this project is an informal CLI and is _not_ maintained by the MPSA PlanDev team.

## Aerie -> PlanDev Rebrand

PlanDev was **formerly known as Aerie and is now named PlanDev**. While we've updated most documentation and external references, some legacy mentions of the old product name may remain as we complete the transition.

What to know:

* The planning product, including modeling, simulation, scheduling and constraint-checking, is now named PlanDev
* The sequencing product, including the sequence editor, workspaces, and actions, is now named SeqDev
* All features and functionality remain the same
* Currently, repository names, package names and other internal code references will retain their existing names, and deployment/migration procedures have not changed
* In a future release, our repository and/or package names may change. If so, this will be communicated to users via release notes and normal communication channels

For the latest documentation, visit: [PlanDev Documentation](https://nasa-ammos.github.io/plandev-docs/)

## Getting Started

Expand All @@ -16,11 +30,11 @@ This short procedure will get you up and running with the basics of the CLI.
python3 -m pip install git+https://github.com/NASA-AMMOS/aerie-cli.git@main
```

3. Configure access to an Aerie host
3. Configure access to an PlanDev host

1. If you've been provided a Configuration JSON, reference that file

2. If you don't have already have a Configuration JSON, copy the following to a JSON file for a local Aerie deployment (replacing the username with your own):
2. If you don't have already have a Configuration JSON, copy the following to a JSON file for a local PlanDev deployment (replacing the username with your own):

```json
[
Expand All @@ -39,15 +53,15 @@ This short procedure will get you up and running with the basics of the CLI.
aerie-cli configurations load -i JSON_FILE
```

4. Activate a configuration to start a session with an Aerie host:
4. Activate a configuration to start a session with a PlanDev host:

```sh
➜ aerie-cli activate
1) localhost
Select an option: 1
```

5. Try out a command to list the plans in Aerie:
5. Try out a command to list the plans in PlanDev:

```sh
aerie-cli plans list
Expand All @@ -69,7 +83,7 @@ This short procedure will get you up and running with the basics of the CLI.

### Setup

Aerie-CLI uses configurations to define different Aerie hosts. Define configurations by either loading JSON configurations or manually via the CLI. Configurations persist on a per-user basis and may be shared between installations.
Aerie-CLI uses configurations to define different PlanDev hosts. Define configurations by either loading JSON configurations or manually via the CLI. Configurations persist on a per-user basis and may be shared between installations.

#### Defining Hosts with a Configuration File

Expand All @@ -85,9 +99,9 @@ You can view the configurations you've loaded with the `configurations list` com
➜ aerie-cli configurations list
Configuration file location: /Users/<username>/Library/Application Support/aerie_cli/config.json

Aerie Host Configurations
PlanDev Host Configurations
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ Host Name ┃ GraphQL API URL ┃ Aerie Gateway URL ┃ Username ┃
┃ Host Name ┃ GraphQL API URL ┃ PlanDev Gateway URL ┃ Username ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
│ localhost │ http://localhost:8080/v1/graphql │ http://localhost:9000 │ │
└───────────┴──────────────────────────────────┴───────────────────────┴──────────┘
Expand All @@ -101,17 +115,17 @@ If you haven't been provided a JSON configuration for a host, you can create a c

Each configuration is stored as JSON object list entry in the configuration file provided with the `configurations list` command. The full contents of a host configuration are:

| Field | Description | Required |
| :-------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `name` | User-facing name of the host | Yes |
| `graphql_url` | URL of the Aerie instance's Hasura GraphQL API | Yes |
| `gateway_url` | URL of the Aerie instance's Gateway | Yes |
| `username` | Username for authentication with Aerie | No |
| `external_auth` | Specification for external authentication required to reach an Aerie instance. See [Configuring for External Authentication](#configuring-for-external-authentication) for details | No |
| Field | Description | Required |
| :-------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- |
| `name` | User-facing name of the host | Yes |
| `graphql_url` | URL of the PlanDev instance's Hasura GraphQL API | Yes |
| `gateway_url` | URL of the PlanDev instance's Gateway | Yes |
| `username` | Username for authentication with PlanDev | No |
| `external_auth` | Specification for external authentication required to reach a PlanDev instance. See [Configuring for External Authentication](#configuring-for-external-authentication) for details | No |

### Sessions and Roles

Aerie-CLI maintains a persistent "session" with an Aerie instance so multiple commands can run without needing to re-authenticate. To start a session, use the `activate` command:
Aerie-CLI maintains a persistent "session" with a PlanDev instance so multiple commands can run without needing to re-authenticate. To start a session, use the `activate` command:

```sh
➜ aerie-cli activate
Expand All @@ -120,15 +134,15 @@ Aerie-CLI maintains a persistent "session" with an Aerie instance so multiple co
Select an option: 1
```

Aerie uses "roles" to adjust what a client is permitted to do. To view the active configuration name and current role, use the `status` command:
PlanDev uses "roles" to adjust what a client is permitted to do. To view the active configuration name and current role, use the `status` command:

```sh
➜ aerie-cli status
Active configuration: localhost
Active role: viewer
```

The default role is configured by Aerie. To change the selected role for the active Aerie-CLI session, use the `role` command:
The default role is configured by PlanDev. To change the selected role for the active Aerie-CLI session, use the `role` command:

```sh
➜ aerie-cli role
Expand Down Expand Up @@ -184,7 +198,7 @@ Alternatively, arguments can be provided using flags:

#### Configuring for External Authentication

Aerie-CLI configurations include a mechanism to authenticate against an external authentication service which may require additional credentials as cookies for accessing Aerie. Aerie-CLI will issue a post request with given JSON data to a provided authentication endpoint and persist any returned cookies in a browser-like manner for the remainder of the Aerie-CLI session.
Aerie-CLI configurations include a mechanism to authenticate against an external authentication service which may require additional credentials as cookies for accessing PlanDev. Aerie-CLI will issue a post request with given JSON data to a provided authentication endpoint and persist any returned cookies in a browser-like manner for the remainder of the Aerie-CLI session.

An external authentication service is configured using the key `external_auth` in the JSON configuration file as follows:

Expand Down Expand Up @@ -220,7 +234,7 @@ In this example, the user would be prompted to enter a value for "password" and,

#### Using a Hasura Admin Secret

In some cases, an admin secret may be used to permit otherwise prohibited requests through Hasura (the software behind the Aerie API). When running a command, the user may add the `--hasura-admin-secret` flag after the `aerie-cli` command to use these elevated privileges for the following command.
In some cases, an admin secret may be used to permit otherwise prohibited requests through Hasura (the software behind the PlanDev API). When running a command, the user may add the `--hasura-admin-secret` flag after the `aerie-cli` command to use these elevated privileges for the following command.

---

Expand All @@ -232,8 +246,8 @@ Instead of using the CLI for interactive use cases, the underlying classes and m

The key constructs are:

- `aerie_cli.aerie_host.AerieHost`: An abstraction for an Aerie Host, including methods for authentication and issuing requests to the Aerie API.
- `aerie_cli.aerie_client.AerieClient`: A class containing common requests and reusable logic to interact with data in Aerie.
- `aerie_cli.aerie_host.AerieHost`: An abstraction for a PlanDev Host, including methods for authentication and issuing requests to the PlanDev API.
- `aerie_cli.aerie_client.AerieClient`: A class containing common requests and reusable logic to interact with data in PlanDev.

The following example defines an `AerieHost` using the necessary URLs, authenticates with a command-line prompt for the user's password, and issues a simple request using one of the built-in requests.

Expand All @@ -243,15 +257,15 @@ from aerie_cli.aerie_host import AerieHost

from getpass import getpass

# These URLs define the Aerie host
# These URLs define the PlanDev host
GRAPHQL_URL = "http://myhostname:8080/v1/graphql"
GATEWAY_URL = "http://myhostname:9000"

# User credentials. The password may be omitted on Aerie instances with authentication disabled
# User credentials. The password may be omitted on PlanDev instances with authentication disabled
USERNAME = "myusername"
PASSWORD = getpass(prompt='Password: ')

# Define the Aerie host and provide user credentials
# Define the host and provide user credentials
aerie_host = AerieHost(GRAPHQL_URL, GATEWAY_URL)
aerie_host.authenticate(USERNAME, PASSWORD)

Expand All @@ -267,7 +281,7 @@ Look through the available methods in the provided `AerieClient` class to find o

### Adding Methods

If you need to write a custom query, you can extend the `AerieClient` class and add your own method. Access the Aerie host using the `aerie_host` property. For example:
If you need to write a custom query, you can extend the `AerieClient` class and add your own method. Access the PlanDev host using the `aerie_host` property. For example:

```py

Expand Down Expand Up @@ -302,7 +316,7 @@ print(plan_id)

### Using the Active CLI Session

If your application will be run by a user who may also be using the CLI, you may reduce the amount of code required to configure an Aerie host and instead just use the active session. Aerie-CLI provides a utility to retrieve an `AerieClient` instance from the active CLI session:
If your application will be run by a user who may also be using the CLI, you may reduce the amount of code required to configure an PlanDev host and instead just use the active session. Aerie-CLI provides a utility to retrieve an `AerieClient` instance from the active CLI session:

```py
from aerie_cli.utils.sessions import get_active_session_client
Expand Down Expand Up @@ -370,7 +384,7 @@ Aerie-CLI has unit tests and integration tests built with the [pytest](https://d

#### Unit Tests

Unit tests can be run anytime and reference local test files. `test_aerie_client.py` is where unit tests are added to exercise particular methods of the `AerieClient` class using mocked Aerie API responses.
Unit tests can be run anytime and reference local test files. `test_aerie_client.py` is where unit tests are added to exercise particular methods of the `AerieClient` class using mocked PlanDev API responses.

Run the unit tests using `pytest` from the `tests/unit_tests` directory:

Expand All @@ -381,7 +395,7 @@ python3 -m pytest .

#### Integration Tests

A separate suite of tests is designed to validate CLI functionality against a local instance of Aerie. See the [integration testing documentation](tests/integration_tests/README.md) for details.
A separate suite of tests is designed to validate CLI functionality against a local instance of PlanDev. See the [integration testing documentation](tests/integration_tests/README.md) for details.

The integration tests are based on `Typer` testing documentation found [here](https://typer.tiangolo.com/tutorial/testing/).

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "aerie-cli"
version = "0.0.0-dev0"
description = "A CLI application and Python API for interacting with Aerie."
version = "2.11.0"
description = "A CLI application and Python API for interacting with PlanDev."
authors = []
license = "MIT"
readme = "README.md"
Expand Down