Skip to content

Commit

Permalink
Revise the comments
Browse files Browse the repository at this point in the history
  • Loading branch information
hackerwins committed Sep 9, 2024
1 parent 934a1d2 commit b55513f
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions docs/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,18 +111,12 @@ Flags:
To use admin commands, you need to log in to the server. You can log in to the server using the `login` subcommand:
```bash
$ yorkie login -u <username> -p <password> --rpc-addr api.yorkie.dev:443
```
Or like this:
```bash
$ yorkie login -u <username> --rpc-addr api.yorkie.dev:443
Enter Password:
```
As shown above, if you do not enter a password with -p flag, you will need to enter it on the next line.
The password will not be visible, which is expected behavior.
Username and password are the same as the ones you used to log in to the [dashboard](/dashboard).
The account is the same as the account you use to log in to the [Dashboard](https://yorkie.dev/dashboard). If you don't have an account, you can create one by signing up at [Dashboard](https://yorkie.dev/dashboard).
> If you are using the [self-hosted server](/docs/self-hosted-server), default username and password are `admin` and `admin`.
> You can log in to the server using `$ yorkie login -u admin -p admin --insecure`. Or: `$ yorkie login -u admin --insecure`.
Expand Down Expand Up @@ -152,7 +146,7 @@ $ yorkie context ls
```
### Change Password
If you want to change your password, you can use the command `passwd`. Both passwords will not be visible, which is expected.
If you want to change your password, you can use the command `passwd`.
```bash
$ yorkie passwd -u <username> --rpc-addr api.yorkie.dev:443
Expand All @@ -164,19 +158,14 @@ Enter New Password:
### Delete Account
If you want to delete your account, you can use the command `delete-account`.
```bash
$ yorkie delete-account -u <username> -p <password> --rpc-addr api.yorkie.dev:443
Warning: ...
```
Or:
```bash
$ yorkie delete-account -u <username> --rpc-addr api.yorkie.dev:443
Enter Password:
WARNING: ...
```
As before, it is expected that the password will not be visible. If the operation fails, please double-check if the account exists and whether the password is correct.
This command will delete your account and all data associated with it. Please be careful when using this command.
### Project
Expand Down

0 comments on commit b55513f

Please sign in to comment.