From 9b8fd3e9369c0d890eea0a8042a2d2d90ae0d8d2 Mon Sep 17 00:00:00 2001 From: Komal Dhull Date: Fri, 23 Feb 2024 13:32:33 -0800 Subject: [PATCH 1/2] Addresses ENG-1537. Adds initial README.md --- README.md | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 97 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2645b6..ca1d6cd 100644 --- a/README.md +++ b/README.md @@ -1 +1,97 @@ -# p0cli +
+ + P0 Security logo + +
+ +# P0 Security CLI + +The offical Command-Line Interface (CLI) for P0. + +Supports creating access requests for cloud resources, assuming AWS roles, and SSHing into AWS instances. + +## Table of Contents + +- [About](#about) +- [Quickstart](#quickstart) + - [Installation](#installation) + - [Configuration](#configuration) +- [Command Reference](#command-reference) +- [Support](#support) +- [Contributing](#contributing) +- [Copyright](#copyright) + +## About + +P0 manages just-in-time access to your cloud resources. The P0 CLI enables developers to seamlessly integrate P0 into their normal workflows by supporting the following use cases: + +- Assume an AWS role or SSH into an AWS instance: P0 will request access, wait for access to be approved and provisioned, and then execute the relevant `aws` command +- Create P0 access requests for any cloud resource + +To learn more about P0, see our [docs](https://docs.p0.dev/). + +## Quickstart + +### Installation + +To install the P0 CLI, run: + +``` +npm install -g @p0security/p0cli +``` + +You can now invoke the CLI by running `p0`. + +### Configuration + +Before you can make requests using the P0 CLI, you will need to authenticate with your P0 organization. If you don't have a P0 organization account yet, follow our [Quick Start guide](https://docs.p0.dev/getting-started/quick-start) to create an account and install a resource for access requests. + +Once you have a P0 organization account, run + +``` +p0 login +``` + +then follow the prompts in your browser to complete authentication. + +You can now request access via + +``` +p0 request +``` + +## CLI Reference + +### Usage + +Interact with the `p0` CLI via: + +``` +p0 +``` + +To view help, use the `--help` option with any command. + +### Available commands + +``` + p0 aws Execute AWS commands + p0 login Log in to p0 using a web browser + p0 ls [arguments..] List request-command arguments + p0 request [arguments..] Manually request permissions on a resource + p0 ssh SSH into a virtual machine +``` + +## Support + +If you encounter any issues with the P0 CLI, you can open a GitHub issue on this repo, email `support@p0.dev`, or reach out to us on our [community slack](https://join.slack.com/t/p0securitycommunity/shared_invite/zt-1zouzlovp-1kuym9RfuzkJ17ZlvAf6mQ). + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## Copyright + +Copyright © 2024-present P0 Security. + +The P0 Security CLI is licensed under the terms of the GNU General Public License version 3. See [COPYING.md](COPYING.md) for details. From eb5f3a014956908f563b70a3ec56e17823b46150 Mon Sep 17 00:00:00 2001 From: komal-dhull <117865035+komal-dhull@users.noreply.github.com> Date: Fri, 23 Feb 2024 17:41:11 -0800 Subject: [PATCH 2/2] Update README.md Co-authored-by: Nathan Brahms --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ca1d6cd..24fd5e8 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The offical Command-Line Interface (CLI) for P0. -Supports creating access requests for cloud resources, assuming AWS roles, and SSHing into AWS instances. +Supports creating access requests for cloud resources, assuming AWS roles, and connecting to AWS instances. ## Table of Contents