Skip to main content

Prerequisites

1. Log in

A browser window opens for authentication. On headless machines (SSH, Docker, CI), the device flow is used automatically - the CLI prints a short URL and code to enter in your browser.
To force device flow on a machine with a browser:
After login, the CLI auto-selects your first tenant and project. Check what was picked:

2. Set up the project

In the project’s directory:
It does only what is missing, so it is safe to run again at any time:
  • Workspace. With no .westyx/config, it writes one from your active tenant, project and environment. To pick different ones first: westyx tenant set <name>, westyx project set <name>, westyx environment set <name>.
  • Values. With no .westyx/.wx, it pulls the project’s values from Nexus. For a project not yet in Nexus it analyzes your .env into .westyx/.wx - review it, then upload it with westyx dev push
    • and offers to remove the WESTYX_* connection settings you no longer need.
  • Credentials. It issues a Developer WIF session for every service your scripts name, so your application authenticates as you, with no API key on the machine.
Name the service each script runs as in .westyx/config, one script per process:
Tools that only read a file, such as docker compose, can get the same values with westyx dev setup --env-file, which writes .env.westyx and adds it to .gitignore.

3. Start your app

Values are injected as environment variables, and the script’s service endpoint as WESTYX_SERVICE_ENDPOINT, which the Nexus SDK reads - so the Nexus client in your code needs neither an endpoint nor a key. If Nexus is unreachable, cached values from .westyx/.wx are used. When a session expires, dev run says so and names the command that renews it.

New machine workflow

For a developer joining a project that already uses Westyx:
To switch accounts, westyx logout then westyx login: logout removes everything of the previous account from the machine.

Next steps

Command reference

Full reference for every command and flag.

CI/CD

Use the CLI in automated pipelines.