Skip to content

chore: document valid identity names #3747

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
viviveevee merged 1 commit into from
May 8, 2024
Merged

chore: document valid identity names #3747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# UNRELEASED

### chore: Improve help text of `dfx identity new` to include which characters are valid in identity names

# 0.20.1

### feat: reformatted error output
Expand Down
6 changes: 3 additions & 3 deletions docs/cli-reference/dfx-identity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,9 @@ dfx identity new [options] _identity-name_

You must specify the following argument for the `dfx identity new` command.

| Argument | Description |
|-------------------|--------------------------------------------------------------------------|
| `<identity_name>` | Specifies the name of the identity to create. This argument is required. |
| Argument | Description |
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `<identity_name>` | Specifies the name of the identity to create. This argument is required. Valid characters are letters, numbers, and these symbols: .-_@ |

### Options

Expand Down
2 changes: 1 addition & 1 deletion src/dfx/src/commands/identity/new.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use IdentityCreationParameters::{Hardware, Pem};
#[derive(Parser)]
pub struct NewIdentityOpts {
#[arg(value_parser = identity_name_validator)]
/// The name of the identity to create.
/// The name of the identity to create. Valid characters are letters, numbers, and these symbols: .-_@
new_identity: String,

#[cfg_attr(
Expand Down