Skip to content
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.

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

Add initial README #35

Merged
merged 2 commits into from
Feb 26, 2024
Merged
Changes from all commits
Commits
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
98 changes: 97 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,97 @@
# p0cli
<div align="center">
<a href="https://github.com/p0-security/p0cli">
<img width="200" height="200" src="https://p0.dev/images/logo.png" alt="P0 Security logo">
</a>
</div>

# P0 Security CLI

The offical Command-Line Interface (CLI) for P0.

Supports creating access requests for cloud resources, assuming AWS roles, and connecting to 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 <P0_ORGANIZATION_ID>
```

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 <command> <options>
```

To view help, use the `--help` option with any command.

### Available commands

```
p0 aws Execute AWS commands
p0 login <org> 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 <instance> 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.
Loading