Skip to content

Commit 3e33e6f

Browse files
nimish-ksrohan-chaturvedi
authored andcommitted
chore: update README and demo (phasehq#596)
* chore: add updated demo video * chore: update demo video * chore: remove redundant assets * feat: 2x demo * feat: update cli ascii art * feat: add Terraform SVG icon * feat: update Phase Console demo image and refine secret sync description * test: video tag on gh * fix: remove video tag, fall back to attachment link * feat: add Amazon EKS SVG icon * docs: enhance README with additional repository links and refine CLI and secret management descriptions * feat: cleanup * docs: update secret sync description in README to reflect new icon * Update README.md Co-authored-by: Rohan Chaturvedi <rohan.chaturvedi@protonmail.com> * Update README.md Co-authored-by: Rohan Chaturvedi <rohan.chaturvedi@protonmail.com> --------- Co-authored-by: rohan-chaturvedi <rohan.chaturvedi@protonmail.com>
1 parent db018b9 commit 3e33e6f

File tree

4 files changed

+40
-41
lines changed

4 files changed

+40
-41
lines changed

README.md

Lines changed: 38 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,38 @@
44
<img height="120" width="450" src="img/phase-lattice-logo.svg" alt="Phase">
55
</a>
66

7-
<a href="https://phase.dev">Website</a> |
8-
<a href="https://docs.phase.dev">Documentation</a> |
9-
<a href="https://docs.phase.dev/security">Security</a> |
10-
<a href="https://github.com/phasehq/console/blob/main/CONTRIBUTING.md">Contributing</a> |
11-
<a href="https://slack.phase.dev">Join Slack</a>
7+
<h5>Repos</h5>
8+
<p>
9+
<a href="https://github.com/phasehq/docs">Docs</a> |
10+
<a href="https://github.com/phasehq/cli">CLI</a> |
11+
<a href="https://github.com/phasehq/node-sdk">Node SDK</a> |
12+
<a href="https://github.com/phasehq/python-sdk">Python SDK</a>
13+
<br/>
14+
<a href="https://github.com/phasehq/golang-sdk">Golang SDK</a> |
15+
<a href="https://github.com/phasehq/kubernetes-secrets-operator/tree/main/phase-console">Helm Chart</a> |
16+
<a href="https://github.com/phasehq/kubernetes-secrets-operator">Kubernetes Operator</a> |
17+
<a href="https://github.com/phasehq/terraform-provider-phase">Terraform Provider</a>
18+
</p>
1219
</div>
1320

1421
---
1522

1623
Open source platform for fast-moving engineering teams to secure and deploy application secrets — from development to production.
17-
18-
A developer-friendly alternative to **HashiCorp Vault** and **AWS Secrets Manager** that works with your whole team 🧑‍💻.
19-
2024
---
2125

22-
# Phase Console
23-
https://github.com/user-attachments/assets/160c721d-a941-440a-bc42-afd419c1df18
24-
26+
[Phase Console Demo](https://github.com/user-attachments/assets/cd6b1ffe-6cb4-4a2b-8ae1-9daa61ed3a5a)
2527

2628
| | **Features** |
2729
| --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
2830
| 📈 | **[Phase Console](https://console.phase.dev)**: Dashboard for seamlessly creating, managing, rotating secrets, and environment variables |
29-
| ⌨️ | **[CLI](https://github.com/phasehq/cli)**: Import existing secrets from `.env` files, encrypt them, and securely inject them in your application at runtime |
30-
| 🤫 | **[Secret management](https://docs.phase.dev/console/apps)**: Secret Diffs, version control, and recovery |
31-
| 🙋 | **[RBAC](https://docs.phase.dev/console/users#user-roles)**: Fine-grained, role-based, and cryptographic access control, per application, per environment. |
32-
| 🔌 | **[Integrations](https://docs.phase.dev/#integrate-phase)**: Automatically sync secrets to GitHub, Cloudflare Pages, GitLab CI, Railway, AWS Secrets Manager, etc. |
33-
| ![Kubernetes](img/kubernetes.svg) | **[Kubernetes](https://docs.phase.dev/integrations/platforms/kubernetes)**: Automatically deploy secrets to your Kubernetes Cluster with End-to-End encryption via Phase Secrets Operator |
34-
| ⛓️ | **[Secret referencing & overrides](https://docs.phase.dev/console/secrets)**: Create personal secrets. Inherit values from other secrets |
35-
| 🌐 | **[REST API](https://docs.phase.dev/public-api/secrets#get-secrets)**: Access and manage secrets programmatically |
31+
| ⌨️ | **[CLI](https://github.com/phasehq/cli)**: Import existing secrets from `.env` files, and securely inject them in your application at runtime or create virtual shells with secrets |
32+
| 🤫 | **[Secret management](https://docs.phase.dev/console/apps)**: Manage secrets across environments, view secret diffs, track version history, and restore secret values with a single click |
33+
| 🙋 | **[Role-based Access Control](https://docs.phase.dev/console/users#user-roles)**: Fine-grained, role-based, and cryptographic access control, per application, per environment. |
34+
| 🔁 | **[Secret sync](https://docs.phase.dev/#integrate-phase)**: Automatically sync secrets to GitHub, Cloudflare Pages, Vercel, GitLab CI, Railway, AWS Secrets Manager, etc. |
35+
| ![Kubernetes](img/kubernetes.svg) | **[Kubernetes](https://docs.phase.dev/integrations/platforms/kubernetes)**: Automatically sync secrets to your Kubernetes Cluster and reload deployments via the Phase Secrets Operator |
36+
| ![Terraform Provider](img/terraform.svg) | **[Terraform](https://docs.phase.dev/integrations/platforms/hashicorp-terraform)**: Manage secrets in your HashiCorp Terraform Iac workflows. |
37+
| ⛓️ | **[Secret referencing & overrides](https://docs.phase.dev/console/secrets)**: Create personal secrets without affecting others on the team. Reference secret values across apps and environments |
38+
| 🌐 | **[REST API](https://docs.phase.dev/public-api/secrets#get-secrets)**: Access and manage secrets programmatically with any http client |
3639
| 📦 | **[SDKs](https://docs.phase.dev/sdks)**: SDKs for integrating Phase with various programming languages and frameworks
3740
| 🥡 | **[Self Hosting](https://docs.phase.dev)**: Run Phase on your own infrastructure |
3841
| 🔍 | **[Audit Logs]()**: Complete visibility into every change and access event | | |
@@ -41,42 +44,33 @@ https://github.com/user-attachments/assets/160c721d-a941-440a-bc42-afd419c1df18
4144

4245
---
4346

44-
## CLI - Import, Encrypt and Inject secrets
45-
46-
![Phase CI](img/phase-cli-import-run.webp)
47+
## CLI
4748

4849
```fish
49-
λ phase
50+
λ phase --help
5051
Securely manage application secrets and environment variables with Phase.
5152
52-
@@@
53-
@@@@@@@@@@
54-
@@@@@@@@@@@@@@@@
55-
P@@@@@&@@@?&@@&@@@@@P
56-
P@@@@# @&@ @P@@@
57-
&@@@# *@& #@@@&
58-
&@@@5 &@? 5@@@&
59-
Y@@@# ^@@ #@@@J
60-
#@@@7 B@5 7@@@#
61-
#@@@? .@@. ?@@@#
62-
@@@@& 5@G &@@@7
63-
#@@@B @@^ #@@@B
64-
B@@@@ .@# 7@@@@B
65-
@@@@@@ &.@ P@@@@@7
66-
@@@@@@@@@@@@@@@@@@@@@
67-
@@@@@@@@@@@@@@@
68-
@@@@@@@@
69-
@@@
53+
/$$
54+
| $$
55+
/$$$$$$ | $$$$$$$ /$$$$$$ /$$$$$$$ /$$$$$$
56+
/$$__ $$| $$__ $$ |____ $$ /$$_____/ /$$__ $$
57+
| $$ \ $$| $$ \ $$ /$$$$$$$| $$$$$$ | $$$$$$$$
58+
| $$ | $$| $$ | $$ /$$__ $$ \____ $$| $$_____/
59+
| $$$$$$$/| $$ | $$| $$$$$$$ /$$$$$$$/| $$$$$$$
60+
| $$____/ |__/ |__/ \_______/|_______/ \_______/
61+
| $$
62+
|__/
7063
7164
options:
7265
-h, --help show this help message and exit
7366
--version, -v
7467
show program's version number and exit
75-
7668
Commands:
69+
7770
auth 💻 Authenticate with Phase
7871
init 🔗 Link your project with your Phase app
7972
run 🚀 Run and inject secrets to your app
73+
shell 🐚 Launch a sub-shell with secrets as environment variables (BETA)
8074
secrets 🗝️ Manage your secrets
8175
secrets list 📇 List all the secrets
8276
secrets get 🔍 Get a specific secret by key
@@ -87,6 +81,7 @@ Commands:
8781
secrets export 🥡 Export secrets in a dotenv format
8882
users 👥 Manage users and accounts
8983
users whoami 🙋 See details of the current user
84+
users switch 🪄 Switch between Phase users, orgs and hosts
9085
users logout 🏃 Logout from phase-cli
9186
users keyring 🔐 Display information about the Phase keyring
9287
docs 📖 Open the Phase CLI Docs in your browser
@@ -111,7 +106,9 @@ The quickest and most reliable way to get started is by signing up on the [Phase
111106
| | **Deploy Phase Console on your infrastructure** |
112107
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
113108
|![Docker](img/docker.svg) | [Docker Compose](https://docs.phase.dev/self-hosting/docker-compose) |
109+
|![Kubernetes](img/kubernetes.svg) | [Kubernetes (Helm chart)](https://docs.phase.dev/self-hosting/kubernetes) |
114110
|![AWS](img/aws.svg) | [AWS](https://docs.phase.dev/self-hosting/aws) |
111+
|![AWS EKS](img/aws-eks.svg) | [AWS EKS (Helm chart)](https://docs.phase.dev/self-hosting/aws-eks) |
115112
|![GCP](img/gcp.svg) | [Google Cloud Platform](https://docs.phase.dev/self-hosting/gcp) |
116113
|![Azure](img/azure.svg) | [Azure](https://docs.phase.dev/self-hosting/azure) |
117114
|![DigitalOcean](img/do.svg) | [DigitalOcean](https://docs.phase.dev/self-hosting/digitalocean) |

img/aws-eks.svg

Lines changed: 1 addition & 0 deletions
Loading

img/console-ui.mp4

-1.27 MB
Binary file not shown.

img/terraform.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)