The PetStore CLI allows users to interact with a simulated pet shop management system. With this tool, you can create, retrieve, update, and delete records for pets, store orders, and users. The documentation uses standard formatting conventions to distinguish literal text, placeholder values, and optional parameters.
petstore <command> [options]
This syntax indicates that you must supply a command accompanied by any necessary options.
Literal text: Commands such as pet, store, and user must be typed exactly as shown.
Placeholder values: Required arguments are denoted by angle brackets, for example, <pet-id>.
Optional arguments: Optional flags or parameters are enclosed in square brackets, for example, [--json].
Repeatable arguments: An ellipsis (...) indicates that an argument may be repeated.
--help
Display help information about the CLI.
--version
Show the current version of the CLI tool.
--verbose
Enable verbose output for debugging and detailed information5.
The CLI has several primary commands, each with its own set of subcommands:
pet – Manage pet records
list
List all available pets.
get <pet-id>
Retrieve details for the pet with the specified ID.
create
Create a new pet record.
update <pet-id>
Update information for an existing pet.
delete <pet-id>
Remove the pet record with the specified ID.
store – Manage store orders
list
List all orders from the store.
get <order-id>
Retrieve details for a specific order.
create
Create a new order.
update <order-id>
Update an existing order.
delete <order-id>
Cancel or delete an order.
user – Manage user accounts
list
List all users registered in the system.
get <user-id>
Retrieve information about a specific user.
create
Create a new user account.
update <user-id>
Update user information.
delete <user-id>
Remove a user account from the system.
Listing all pets:
petstore pet list
This command returns a list of all pets in the PetStore system.
Retrieving details for a specific pet:
petstore pet get 12345
Replace <pet-id> (here 12345) with the actual pet identifier to fetch its details.
Creating a new pet:
petstore pet create --name "Buddy" --species "Dog" --age 3
This command creates a pet record with the provided name, species, and age.
Updating an existing pet:
petstore pet update 12345 --name "Buddy" --age 4
Here, the pet with ID 12345 is updated with a new name or altered details as required.
Deleting a pet:
petstore pet delete 12345
This command deletes the pet with the given ID from the system.
Listing all orders:
petstore store list
This displays a list of all orders in the PetStore system.
Creating a new order:
petstore store create --pet-id 12345 --user-id 67890 --quantity 2
This example creates an order record associating a pet with a user and specifying the quantity ordered3.
Creating a new user:
petstore user create --username "jdoe" --email "[email protected]"
Register a new user with a username and email address.
Listing all users:
petstore user list
This command outputs a list of all users registered in the system.
To view detailed help for any command, append --help to the command. For example:
petstore pet --help
This displays usage information, available options, and further examples for that command.