Skip to content

chore: update README and demo #596

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
merged 15 commits into from
Jun 24, 2025
Merged

chore: update README and demo #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3ee8bcb
chore: add updated demo video
rohan-chaturvedi Jun 21, 2025
7875484
chore: update demo video
rohan-chaturvedi Jun 21, 2025
6a028d2
chore: remove redundant assets
rohan-chaturvedi Jun 21, 2025
fadf39b
feat: 2x demo
nimish-ks Jun 23, 2025
f04a59f
feat: update cli ascii art
nimish-ks Jun 23, 2025
834806f
feat: add Terraform SVG icon
nimish-ks Jun 23, 2025
e77291c
feat: update Phase Console demo image and refine secret sync description
nimish-ks Jun 23, 2025
2ca35ef
test: video tag on gh
nimish-ks Jun 23, 2025
70d6202
fix: remove video tag, fall back to attachment link
nimish-ks Jun 23, 2025
605f2f5
feat: add Amazon EKS SVG icon
nimish-ks Jun 24, 2025
d33a05a
docs: enhance README with additional repository links and refine CLI โ€ฆ
nimish-ks Jun 24, 2025
77a16b3
feat: cleanup
nimish-ks Jun 24, 2025
39afe99
docs: update secret sync description in README to reflect new icon
nimish-ks Jun 24, 2025
1537264
Update README.md
nimish-ks Jun 24, 2025
930a81b
Update README.md
nimish-ks Jun 24, 2025
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
79 changes: 38 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,38 @@
<img height="120" width="450" src="img/phase-lattice-logo.svg" alt="Phase">
</a>

<a href="https://phase.dev">Website</a> |
<a href="https://docs.phase.dev">Documentation</a> |
<a href="https://docs.phase.dev/security">Security</a> |
<a href="https://github.com/phasehq/console/blob/main/CONTRIBUTING.md">Contributing</a> |
<a href="https://slack.phase.dev">Join Slack</a>
<h5>Repos</h5>
<p>
<a href="https://github.com/phasehq/docs">Docs</a> |
<a href="https://github.com/phasehq/cli">CLI</a> |
<a href="https://github.com/phasehq/node-sdk">Node SDK</a> |
<a href="https://github.com/phasehq/python-sdk">Python SDK</a>
<br/>
<a href="https://github.com/phasehq/golang-sdk">Golang SDK</a> |
<a href="https://github.com/phasehq/kubernetes-secrets-operator/tree/main/phase-console">Helm Chart</a> |
<a href="https://github.com/phasehq/kubernetes-secrets-operator">Kubernetes Operator</a> |
<a href="https://github.com/phasehq/terraform-provider-phase">Terraform Provider</a>
</p>
</div>

---

Open source platform for fast-moving engineering teams to secure and deploy application secrets โ€” from development to production.

A developer-friendly alternative to **HashiCorp Vault** and **AWS Secrets Manager** that works with your whole team ๐Ÿง‘โ€๐Ÿ’ป.

---

# Phase Console
https://github.com/user-attachments/assets/160c721d-a941-440a-bc42-afd419c1df18

[Phase Console Demo](https://github.com/user-attachments/assets/cd6b1ffe-6cb4-4a2b-8ae1-9daa61ed3a5a)

| | **Features** |
| --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ๐Ÿ“ˆ | **[Phase Console](https://console.phase.dev)**: Dashboard for seamlessly creating, managing, rotating secrets, and environment variables |
| โŒจ๏ธ | **[CLI](https://github.com/phasehq/cli)**: Import existing secrets from `.env` files, encrypt them, and securely inject them in your application at runtime |
| ๐Ÿคซ | **[Secret management](https://docs.phase.dev/console/apps)**: Secret Diffs, version control, and recovery |
| ๐Ÿ™‹ | **[RBAC](https://docs.phase.dev/console/users#user-roles)**: Fine-grained, role-based, and cryptographic access control, per application, per environment. |
| ๐Ÿ”Œ | **[Integrations](https://docs.phase.dev/#integrate-phase)**: Automatically sync secrets to GitHub, Cloudflare Pages, GitLab CI, Railway, AWS Secrets Manager, etc. |
| ![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 |
| โ›“๏ธ | **[Secret referencing & overrides](https://docs.phase.dev/console/secrets)**: Create personal secrets. Inherit values from other secrets |
| ๐ŸŒ | **[REST API](https://docs.phase.dev/public-api/secrets#get-secrets)**: Access and manage secrets programmatically |
| โŒจ๏ธ | **[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 |
| ๐Ÿคซ | **[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 |
| ๐Ÿ™‹ | **[Role-based Access Control](https://docs.phase.dev/console/users#user-roles)**: Fine-grained, role-based, and cryptographic access control, per application, per environment. |
| ๐Ÿ” | **[Secret sync](https://docs.phase.dev/#integrate-phase)**: Automatically sync secrets to GitHub, Cloudflare Pages, Vercel, GitLab CI, Railway, AWS Secrets Manager, etc. |
| ![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 |
| ![Terraform Provider](img/terraform.svg) | **[Terraform](https://docs.phase.dev/integrations/platforms/hashicorp-terraform)**: Manage secrets in your HashiCorp Terraform Iac workflows. |
| โ›“๏ธ | **[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 |
| ๐ŸŒ | **[REST API](https://docs.phase.dev/public-api/secrets#get-secrets)**: Access and manage secrets programmatically with any http client |
| ๐Ÿ“ฆ | **[SDKs](https://docs.phase.dev/sdks)**: SDKs for integrating Phase with various programming languages and frameworks
| ๐Ÿฅก | **[Self Hosting](https://docs.phase.dev)**: Run Phase on your own infrastructure |
| ๐Ÿ” | **[Audit Logs]()**: Complete visibility into every change and access event | | |
Expand All @@ -41,42 +44,33 @@ https://github.com/user-attachments/assets/160c721d-a941-440a-bc42-afd419c1df18

---

## CLI - Import, Encrypt and Inject secrets

![Phase CI](img/phase-cli-import-run.webp)
## CLI

```fish
ฮป phase
ฮป phase --help
Securely manage application secrets and environment variables with Phase.

@@@
@@@@@@@@@@
@@@@@@@@@@@@@@@@
P@@@@@&@@@?&@@&@@@@@P
P@@@@# @&@ @P@@@
&@@@# *@& #@@@&
&@@@5 &@? 5@@@&
Y@@@# ^@@ #@@@J
#@@@7 B@5 7@@@#
#@@@? .@@. ?@@@#
@@@@& 5@G &@@@7
#@@@B @@^ #@@@B
B@@@@ .@# 7@@@@B
@@@@@@ &.@ P@@@@@7
@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@
@@@@@@@@
@@@
/$$
| $$
/$$$$$$ | $$$$$$$ /$$$$$$ /$$$$$$$ /$$$$$$
/$$__ $$| $$__ $$ |____ $$ /$$_____/ /$$__ $$
| $$ \ $$| $$ \ $$ /$$$$$$$| $$$$$$ | $$$$$$$$
| $$ | $$| $$ | $$ /$$__ $$ \____ $$| $$_____/
| $$$$$$$/| $$ | $$| $$$$$$$ /$$$$$$$/| $$$$$$$
| $$____/ |__/ |__/ \_______/|_______/ \_______/
| $$
|__/

options:
-h, --help show this help message and exit
--version, -v
show program's version number and exit

Commands:

auth ๐Ÿ’ป Authenticate with Phase
init ๐Ÿ”— Link your project with your Phase app
run ๐Ÿš€ Run and inject secrets to your app
shell ๐Ÿš Launch a sub-shell with secrets as environment variables (BETA)
secrets ๐Ÿ—๏ธ Manage your secrets
secrets list ๐Ÿ“‡ List all the secrets
secrets get ๐Ÿ” Get a specific secret by key
Expand All @@ -87,6 +81,7 @@ Commands:
secrets export ๐Ÿฅก Export secrets in a dotenv format
users ๐Ÿ‘ฅ Manage users and accounts
users whoami ๐Ÿ™‹ See details of the current user
users switch ๐Ÿช„ Switch between Phase users, orgs and hosts
users logout ๐Ÿƒ Logout from phase-cli
users keyring ๐Ÿ” Display information about the Phase keyring
docs ๐Ÿ“– Open the Phase CLI Docs in your browser
Expand All @@ -111,7 +106,9 @@ The quickest and most reliable way to get started is by signing up on the [Phase
| | **Deploy Phase Console on your infrastructure** |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|![Docker](img/docker.svg) | [Docker Compose](https://docs.phase.dev/self-hosting/docker-compose) |
|![Kubernetes](img/kubernetes.svg) | [Kubernetes (Helm chart)](https://docs.phase.dev/self-hosting/kubernetes) |
|![AWS](img/aws.svg) | [AWS](https://docs.phase.dev/self-hosting/aws) |
|![AWS EKS](img/aws-eks.svg) | [AWS EKS (Helm chart)](https://docs.phase.dev/self-hosting/aws-eks) |
|![GCP](img/gcp.svg) | [Google Cloud Platform](https://docs.phase.dev/self-hosting/gcp) |
|![Azure](img/azure.svg) | [Azure](https://docs.phase.dev/self-hosting/azure) |
|![DigitalOcean](img/do.svg) | [DigitalOcean](https://docs.phase.dev/self-hosting/digitalocean) |
Expand Down
1 change: 1 addition & 0 deletions img/aws-eks.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed img/console-ui.mp4
View file
Open in desktop
Binary file not shown.
1 change: 1 addition & 0 deletions img/terraform.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.