Skip to content

Commit

Permalink
updating cli docs (#27921)
Browse files Browse the repository at this point in the history
  • Loading branch information
fabrizzio-dotCMS committed Mar 8, 2024
1 parent f979a39 commit ad4f2df
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion tools/dotcms-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,6 @@ If the `dot-service.yml` file does not exist, the CLI will prompt to create one
The CLI provides a `config` command to set the initial configuration required by all commands to operate. The command will guide you through the process of adding a new instance profile to the `dot-service.yml` file. and setting the active profile.
See the [Configuration](cli/docs/config.adoc) section for more details. And the [Examples](#examples) section for a practical example.
```shell script
### Workspace
Expand All @@ -246,6 +245,7 @@ The workspace is basically a set of directories and files used to house and orga
Additionally, a marker file called `.dot-workspace.yml` indicates to the CLI that the current directory is a valid workspace.
In the following table you can see the different directories and files that conform a workspace.
| File/Directory | Type | Description |
|----------------------|------|-------------------------|
| `content-types/` | Dir | Content-Types directory |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
)
public class EntryCommand implements DotCommand{

public static final String NAME = "@|bold,magenta dotCLI|@";
public static final String NAME = "dotCLI";

// Declared here, so we have an instance available via Arc container on the Customized CommandLine
@Inject
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
name = PullCommand.NAME,
header = "@|bold,blue dotCMS global pull|@",
description = {
" This command pull Sites, Content Types, Languages and Files to the server.",
" This command pull Sites, Content Types, Languages and Files from the server.",
"" // empty string here so we can have a new line
}
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public class AuthenticationMixin {

@CommandLine.Option(names = {"--token","-tk"},
description = {
"A dot CMS token to use for authentication. "}, parameterConsumer = TokenConsumer.class)
"A dotCMS token to use for authentication. "}, parameterConsumer = TokenConsumer.class)
String token;

/**
Expand Down

0 comments on commit ad4f2df

Please sign in to comment.