overlane project update | Overlane Docs

Changes the name, the hosted code layer or the code map context of the project. Changing policy needs a role that may manage it.

Usage

overlane project update [project-id] [--name NAME] [--code-layer on|off] [--code-map-context default|on|off] [--dry-run]

Arguments

Argument	Required	Description
`project-id`	no	The project; default is the one this folder is connected to

Flags

Flag	Type	Required	Description
`--name`	string	no	The new project name
`--code-layer`	one of `on`, `off`	no	Turn the hosted code layer on or off
`--code-map-context`	one of `default`, `on`, `off`	no	Whether the code map is added to session context
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane project update --name my-app
overlane project update --code-layer on

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema project update.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "project": {
          "type": "object",
          "properties": {
            "projectId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "archivedAt": {
              "type": "string"
            },
            "deletedAt": {
              "type": "string"
            },
            "restoreDaysLeft": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "projectId",
            "name"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "project"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.