Skip to content

Commit

Permalink
docs: update some texts
Browse files Browse the repository at this point in the history
Also reorder some options (`--format` always at the end for example)
  • Loading branch information
davlgd committed Jul 2, 2024
1 parent de90024 commit 2aa10ea
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions bin/clever.js
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ function run () {
metavar: 'after',
aliases: ['since'],
parser: Parsers.date,
description: 'Fetch logs after this date/time (ISO8601)',
description: 'Fetch logs after this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)',
}),
aliasCreation: cliparse.option('alias', {
aliases: ['a'],
Expand All @@ -190,7 +190,7 @@ function run () {
metavar: 'before',
aliases: ['until'],
parser: Parsers.date,
description: 'Fetch logs before this date/time (ISO8601 date or duration, positive number in seconds or duration Ex: 1h)',
description: 'Fetch logs before this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)',
}),
branch: cliparse.option('branch', {
aliases: ['b'],
Expand Down Expand Up @@ -702,7 +702,7 @@ function run () {
const appCreateCommand = cliparse.command('create', {
description: 'Create an application',
args: [args.appNameCreation],
options: [opts.instanceType, opts.orgaIdOrName, opts.aliasCreation, opts.region, opts.github, opts.humanJsonOutputFormat, opts.taskCommand],
options: [opts.instanceType, opts.orgaIdOrName, opts.aliasCreation, opts.region, opts.github, opts.taskCommand, opts.humanJsonOutputFormat],
}, create('create'));

// CURL COMMAND
Expand Down Expand Up @@ -1174,7 +1174,7 @@ function run () {
name: 'clever',
description: 'CLI tool to manage Clever Cloud\'s data and products',
version: pkg.version,
options: [opts.color, opts.verbose, opts.updateNotifier],
options: [opts.color, opts.updateNotifier, opts.verbose],
helpCommand: false,
commands,
});
Expand Down
2 changes: 1 addition & 1 deletion docs/applications-config.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Clever Cloud Applications: configuration

A Clever Cloud application can easily be configured once created, through following commands. All can target a specific application, adding `--app APP_ID_OR_NAME` or a local alias (`--alias`, `-a`).
A Clever Cloud application can easily be configured once created, through following commands. Each can target a specific application, adding `--app APP_ID_OR_NAME` or a local alias (`--alias`, `-a`).

## config

Expand Down
4 changes: 2 additions & 2 deletions docs/applications-deployment-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ You can also get logs from a specific timeline, deployment or add-on through opt

```
[--before, --until] BEFORE Fetch logs before this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)
[--after, --since] AFTER Fetch logs after this date/time (ISO8601)
[--after, --since] AFTER Fetch logs after this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)
[--search] SEARCH Fetch logs matching this pattern
[--deployment-id] DEPLOYMENT_ID Fetch logs for a given deployment
[--addon] ADDON_ID Add-on ID
Expand All @@ -118,7 +118,7 @@ You can also get access logs from a specific timeline or add-on through options,

```
[--before, --until] BEFORE Fetch logs before this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)
[--after, --since] AFTER Fetch logs after this date/time (ISO8601)
[--after, --since] AFTER Fetch logs after this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)
[--format, -F] FORMAT Output format (human, json, json-stream) (default: human)
```

Expand Down
2 changes: 1 addition & 1 deletion src/command-options.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ function getExitOnOption () {
const availableExitOn = ['deploy-start', 'deploy-end', 'never'];
return cliparse.option('exit-on', {
aliases: ['e'],
metavar: 'exiton',
metavar: 'step',
parser: (exitOnStrategy) => {
return availableExitOn.includes(exitOnStrategy)
? cliparse.parsers.success(exitOnStrategy)
Expand Down

0 comments on commit 2aa10ea

Please sign in to comment.