Documentation

Command line

Manage workspace projects and deployments from the IWE Code command line.

Use the application binary to manage projects, configure deployments, and transfer files. Workspace commands run without a window. Transfers connect to the server configured in the deployment profile.

Commands

These commands run from the application binary. Directories, files, and deep links keep opening the workspace as before.

iwe open [directory]
Start the application. With a directory, open that project.
iwe workspace list [--json]
Print spaces with their projects.
iwe workspace add-project <directory> [--space NAME] [--json]
Add a project directory to a space. Without --space, the first space receives it.
iwe workspace remove-project <project> [--json]
Remove a project by directory or exact name.
iwe --help, iwe --version
Print localized help or the version.

Deployment commands

iwe deployment list
List deployment connections, SSH keys, and profiles.
iwe deployment connection add <name> --host HOST --username NAME [options]
Add a connection.
iwe deployment connection set <name> [options]
Update a connection.
iwe deployment connection remove <name>
Remove an unused connection and its stored secret.
iwe deployment key add <name> <path>
Register an SSH key file.
iwe deployment key remove <name>
Remove an unused SSH key and its stored passphrase.
iwe deployment profile add <name> --project DIR --connection NAME --root PATH --mapping LOCAL=REMOTE [options]
Create a deployment profile with at least one folder mapping.
iwe deployment profile set <name> [options]
Update a profile.
iwe deployment profile remove <name> [--space NAME]
Remove a profile.
iwe deployment test <profile>
Check the connection for a profile.
iwe deployment upload <profile> <path>
Upload a local file or folder.
iwe deployment download <profile> <remote> [--overwrite]
Download a remote file or folder. Use --overwrite to replace local files.
iwe deployment list-remote <profile> [directory]
List a remote directory.

Deployment options

  • Deployment commands accept --json. Add --help to any command to see its options.
  • Use --space NAME with profile commands, test, upload, download, or list-remote to select a space.
  • Connection add and set also accept --protocol, --port, --auth, --key, and --password-stdin. Enter passwords through standard input.
  • Repeat --mapping LOCAL=REMOTE and --exclude PATH as needed. Use --default false to clear the default status. With profile set, --clear-excluded removes exclusions.
  • On first SFTP connection, verify the reported server fingerprint. Then retry the command with --trust-host-key FINGERPRINT. If the command still reports an unknown key, run it again to use the saved fingerprint.

Machine-readable output

The --json flag prints stable JSON with two-space indentation. Keys use snake_case, matching the saved workspace file.

{
  "spaces": [
    {
      "name": "Work",
      "projects": [
        {
          "name": "app",
          "directory": "/Users/name/code/app",
          "pinned": false
        }
      ]
    }
  ]
}

Exit codes

Scripts can branch on the exit code.

0
The command completed.
1
The command failed. The workspace may be unreadable, a project or profile may be missing, or a transfer may have failed.
2
The invocation was invalid: an unknown command or option, a missing value, or open received a missing directory.

Good to know

  • Close the application before changing the workspace from the command line. Both processes save without locking.
  • IWE_LANG or your system language selects the output language, including help text.
  • Unknown commands now stop with an error instead of opening the window.

Full command reference