Skip to content

SP-1534: add description messages where they were missing #394

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

Open
Jing Sun (kuvia) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SP-1534: add description messages where they were missing #394

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
3 changes: 2 additions & 1 deletion src/commands/action-flows/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ import { SkillCommandService } from "./skill/skill-command.service";
class Module extends IModule {

public register(context: Context, configurator: Configurator): void {
const analyzeCommand = configurator.command("analyze");
const analyzeCommand = configurator.command("analyze")
.description("Analyze action flows and return its dependencies");
analyzeCommand.command("action-flows")
.description("Analyze Action Flows dependencies for a certain package")
.requiredOption("--packageId <packageId>", "ID of the package from which you want to export Action Flows")
Expand Down
6 changes: 4 additions & 2 deletions src/commands/data-pipeline/connection/connection.commands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@ export class ConnectionCommands {
.requiredOption("--dataPoolId <dataPoolId>", "ID of the data pool")
.action(this.listConnections);

const getCommand = configurator.command("get");
const getCommand = configurator.command("get")
.description("get data pool connection");
getCommand.command("connection")
.description("Programmatically read properties of your connections")
.requiredOption("--dataPoolId <dataPoolId>", "Id of the data pool you want to update")
.requiredOption("--connectionId <connectionId>", "Id of the connection you want to update")
.action(this.getCommandProperties);

const setCommand = configurator.command("set");
const setCommand = configurator.command("set")
.description("set data pool connection");
setCommand.command("connection")
.description("Programmatically update properties of your connections")
.requiredOption("--dataPoolId <dataPoolId>", "Id of the data pool you want to update")
Expand Down
3 changes: 2 additions & 1 deletion src/commands/data-pipeline/data-pool/data-pool.commands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ export class DataPoolCommands {
.description("Command to push data pools")
.action(this.pushDataPools);

const updateCommand = configurator.command("update");
const updateCommand = configurator.command("update")
.description("Update data pool");

@tneum-celonis Thomas Neumüller (tneum-celonis) Jul 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be a bit more elaborate, no? 😄

updateCommand.command("data-pool")
.description("Command to update a data pool using a data pool configuration file")
.requiredOption("--id <id>", "Id of the data pool you want to update")
Expand Down
6 changes: 4 additions & 2 deletions src/commands/deployment/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import { DeploymentService } from "./deployment.service";
class Module extends IModule {

public register(context: Context, configurator: Configurator): void {
const deploymentCommand = configurator.command("deployment").beta();
const deploymentCommand = configurator.command("deployment").beta()
.description("Create deployments, list their history, check active deployments, and retrieve deployables and targets");

deploymentCommand.command("create")
.beta()
Expand All @@ -18,7 +19,8 @@ class Module extends IModule {
.option("--json", "Return the response as a JSON file")
.action(this.createDeployment);

const listCommand = deploymentCommand.command("list").beta();
const listCommand = deploymentCommand.command("list")
.description("List deployment history, active deployments, deployables or targets").beta();

listCommand.command("history")
.beta()
Expand Down
4 changes: 4 additions & 0 deletions src/content-cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ export function createProgram(context: Context, opts: CreateProgramOptions = {})
*/
function configureRootCommands(configurator: Configurator): void {
configurator.command("list").description("Commands to list content.").alias("ls");
configurator.command("export").description("Export resource: action flow or data pool");
configurator.command("import").description("Import resource: action flow or data pool");
configurator.command("pull").description("Pull resource: skill, bookmark, view bookmark, data pool or asset");
configurator.command("push").description("Push resource: asset, skill, bookmark, view bookmark, CTP or data pool");
}

async function run(): Promise<void> {
Expand Down
Loading