Commands

Overview

A command is the main process of a capsule. You give it at creation as cmd: the program, then its arguments. The capsule ends when the command exits.

The command can start other processes. The capsule waits only for the command. When the command exits, the other processes end with the capsule.

For one command, capsules.run creates the capsule, waits for the command, reads the output, and ends the capsule. It returns the exit code, the output, and the id.

A command can use the name of a service when the capsule is created in a desk with an environment. See Capsules.

Tasks

Run a command

Reason for the task

Run a command in a new capsule and read the output and the exit code.

Job set-up

• Access: you.
• References: POST /v1/capsules, POST /v1/capsules/{id}/wait, GET /v1/capsules/{id}/logs.

Procedure

1. Create the capsule with the command. The call returns at once.

   PythonCopy

   sb = kl.capsules.create(cmd=["python3", "-c", "print(6 * 7)"], packages=["python3"])

   TypeScriptCopy

   const sb = await kl.capsules.create({ cmd: ["python3", "-c", "print(6 * 7)"], packages: ["python3"] });

   GoCopy

   sb, err := kl.Capsules.Create(kloudlite.CreateCapsule{Cmd: []string{"python3", "-c", "print(6 * 7)"}, Packages: []string{"python3"}})if err != nil {    log.Fatal(err)}

   RubyCopy

   sb = kl.capsules.create(cmd: ["python3", "-c", "print(6 * 7)"], packages: ["python3"])

   JavaCopy

   var sb = kl.capsules().create(new Kloudlite.CreateCapsule().cmd(List.of("python3", "-c", "print(6 * 7)")).packages("python3"));

   CLICopy

   kode capsules create --package python3 -- python3 -c 'print(6 * 7)'

2. Wait for the command to exit. The call returns the exit code.

   PythonCopy

   code = sb.wait()

   TypeScriptCopy

   const code = await sb.wait();

   GoCopy

   code, err := sb.Wait(0)if err != nil {    log.Fatal(err)}

   RubyCopy

   code = sb.wait

   JavaCopy

   int code = sb.waitFor(null);

   CLICopy

   kode capsules wait cap-3c4d5e6f7a8b9c0d

3. Read the output.

   PythonCopy

   print(sb.logs())

   TypeScriptCopy

   console.log(await sb.logs());

   GoCopy

   out, err := sb.Logs(false)if err != nil {    log.Fatal(err)}fmt.Print(out)

   RubyCopy

   puts sb.logs

   JavaCopy

   System.out.print(sb.logs(false));

   CLICopy

   kode capsules logs cap-3c4d5e6f7a8b9c0d

Close-out

1. Make sure that the output shows 42 and the exit code is 0.
2. Delete the record if you do not need it, as in Terminate a capsule.

To run one command in one call, use run. The call ends the capsule for you.

res = kl.capsules.run(cmd=["python3", "-c", "print(6 * 7)"], packages=["python3"])print(res["exit_code"], res["stdout"])

const res = await kl.capsules.run({ cmd: ["python3", "-c", "print(6 * 7)"], packages: ["python3"] });console.log(res.exitCode, res.stdout);

res, err := kl.Capsules.Run(kloudlite.RunCapsule{Capsule: kloudlite.CreateCapsule{Cmd: []string{"python3", "-c", "print(6 * 7)"}, Packages: []string{"python3"}}})if err != nil {	log.Fatal(err)}fmt.Println(res.ExitCode, res.Stdout)

res = kl.capsules.run(cmd: ["python3", "-c", "print(6 * 7)"], packages: ["python3"])puts res["exit_code"], res["stdout"]

var res = kl.capsules().run(new Kloudlite.RunCapsule().cmd(List.of("python3", "-c", "print(6 * 7)")).packages("python3"));System.out.println(res.exitCode + " " + res.stdout);

kode capsules run --package python3 -- python3 -c 'print(6 * 7)'

Troubleshooting