Skip to content

Commit 9677998

Browse files
Merge pull request #67 from MatrixAI/feature-getting-started-cli-tutorial
Feature getting started cli tutorial
2 parents 1cb9500 + c742016 commit 9677998

File tree

4 files changed

+32
-8
lines changed

4 files changed

+32
-8
lines changed

docs/tutorials/polykey-cli/README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ import DocCardList from '@theme/DocCardList';
22

33
# Polykey CLI
44

5-
The Command Line Interface (CLI) of Polykey is the first and primary user-interface (UI) to the Polykey system. The CLI is intended for developers and system administrators.
5+
The Polykey Command Line Interface (CLI) is the primary user interface for the Polykey system, tailored for developers and system administrators. It was conceived from the necessity of managing secrets efficiently during software development and deployment workflows.
66

7-
This is because the idea of Polykey came from our experience dealing with secrets as software engineers during the development and deployment workflow.
7+
## Overview
88

9-
New features will always arrive in the CLI first, for testing and integration, before being ported to the other UIs.
9+
The Polykey CLI is the first and primary interface to the Polykey system. It is intended for developers and system administrators who require an advanced tool for managing secrets efficiently. New features are introduced in the CLI first, serving as a testing and integration ground before being ported to other user interfaces. This approach ensures that the features are reliable and refined for professional use.
1010

1111
We designed the CLI user-experience (UX) to be suitable for a human operator, but also to be easily scripted and integrated into other tools.
1212

13-
The tutorial here should be followed in-order, and the goal is to make use of Polykey to manage secrets for a simple application from development to deployment.
13+
The tutorial here should be followed in order, and the goal is to make use of Polykey to manage secrets for a simple application from development to deployment.
1414

1515
The CLI is open-source and available on GitHub: [Polykey CLI](https://github.com/MatrixAI/Polykey-CLI).
1616

@@ -23,10 +23,34 @@ We automatically build and test the CLI on the following platforms:
2323
- Windows x64
2424
- Docker
2525

26-
:::warning
26+
:::note
27+
Polykey is currently in beta. Its interface is at various levels of stability. So bear with us as we perfect its design. You can contribute by discussing with us on [Discord](https://discord.gg/h3UShM8WUN) or creating issue tickets in the [Polykey-CLI repo on GitHub](https://github.com/MatrixAI/Polykey-CLI).
28+
:::
29+
30+
## Getting Started
2731

28-
Polykey is currently in beta. Its interface is at various levels of stability. So bear with us as we perfect its design.
32+
To begin managing & sharing secrets effectively with Polykey, follow the tutorials in the sequence outlined below:
2933

34+
:::tip
35+
You may also reference the following [demo video](https://vimeo.com/884649667) for the getting started tutorial but you will first need to complete the installation instructions for Polykey-CLI.
3036
:::
3137

38+
1. **[Installation](/docs/tutorials/polykey-cli/installation)**: Set up Polykey CLI on your preferred platform.
39+
2. **[Bootstrap Keypair](/docs/tutorials/polykey-cli/bootstrapping)**: Initialize your node and connect to the Polykey network.
40+
3. **[Managing Vaults](/docs/tutorials/polykey-cli/managing-vaults)**: Create and manage secure vaults for effective secrets storage.
41+
4. **[Managing Secrets](/docs/tutorials/polykey-cli/managing-secrets)**: Explore comprehensive methods for handling and organizing secrets within vaults.
42+
5. **[Claiming Digital Identities](/docs/tutorials/polykey-cli/claiming-digital-identities)**: Authenticate and establish your identity across the Polykey network.
43+
6. **[Discovering Other User's Identities](/docs/tutorials/polykey-cli/discovering-other-users)**: Locate and verify identities of other users to manage access.
44+
7. **[Sharing Vaults](/docs/tutorials/polykey-cli/sharing-vaults)**: Share vaults securely with trusted peers.
45+
46+
These initial tutorials will guide new users through the basic functionalities of setting up Polykey, starting their node (similar to creating a Web3 wallet connected to a P2P network), creating virtual encrypted vaults, and managing secret files within these vaults. This foundation prepares users for more advanced network functionalities, such as identity claims, discovery of other users' nodes, and secure sharing of secrets and vaults through end-to-end encryption.
47+
48+
After mastering these basics, you'll be ready to explore intermediate use-cases such as:
49+
50+
- Managing multiple local nodes
51+
- Linking multiple nodes to a single identity
52+
- Using Polykey's `env` command to inject secrets into your development environment
53+
54+
These topics will be covered in more detail in the next section of our documentation, providing you with the tools to leverage Polykey's full potential in more complex operational environments.
55+
3256
<DocCardList />

docs/tutorials/polykey-cli/connecting-to-the-network.md

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Discovering other user's Identities

sidebars.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ const sidebars: SidebarsConfig = {
2323
'tutorials/polykey-cli/bootstrapping',
2424
'tutorials/polykey-cli/managing-vaults',
2525
'tutorials/polykey-cli/managing-secrets',
26-
'tutorials/polykey-cli/connecting-to-the-network',
2726
'tutorials/polykey-cli/claiming-digital-identities',
27+
'tutorials/polykey-cli/discovering-other-users',
2828
'tutorials/polykey-cli/sharing-vaults',
2929
],
3030
},

0 commit comments

Comments
 (0)