Skip to main content

wf

wf​

CLI interface for Wayfinder

Synopsis​

CLI interface for Wayfinder

Getting started with the Wayfinder CLI

To log in to Wayfinder use the API URL of your Wayfinder instance, for example: $ wf login -a https://api-wayfinder.myorg.com

To set the current workspace once logged in: $ wf use workspace NAME

To authenticate using an API token, export the following environment variables:

  • WAYFINDER_SERVER API URL for your Wayfinder instance, e.g. https://api-wayfinder.myorg.com
  • WAYFINDER_TOKEN Platform or workspace access token
  • WAYFINDER_WORKSPACE Workspace to use by default with the token (optional)

To get help with any command, use wf help COMMAND, e.g.: $ wf help login

Visit https://docs.appvia.io/wayfinder/getting-started/cli for more help getting started.

wf [flags]

Examples​

wf command [options] [-w|--workspace]

Options​

      --debug              Debug / trace logging (default: false)
      --force              Force operation to happen (default: false)
  -h, --help               help for wf
      --no-wait            Do not wait for resources to provision
  -o, --output string      Output format of the resource (json,yaml,table) (default "table")
      --profile string     Use a profile other than your current - to change current: wf use profile NAME
      --show-headers       Display headers on table out (default true)
      --verbose            Verbose logging (default: false)
  -w, --workspace string   Workspace to use - to change default: wf use workspace NAME

SEE ALSO​

  • wf access - Gains access to a Wayfinder-managed resource
  • wf api-resources - Returns a list of all the available resources
  • wf apply - Allows you to apply a set of resources from files
  • wf assign - Assign allows you to assign access roles (for cluster access) or wayfinder roles (for access to Wayfinder itself) to access tokens
  • wf assume - Escalates your privileges for a short-lived time
  • wf completion - Provides the autocomplete output so you can source into your shell
  • wf create - Creates one or more resources
  • wf delete - Lets you delete one or more resources
  • wf deploy - Deploys a resource to Wayfinder
  • wf describe - Describes the detail of a resource
  • wf diff - Allows you to see a diff between the existing and supplied resource
  • wf disable - Disables a resource
  • wf edit - Allows you to edit a resource
  • wf enable - Enables a resource
  • wf export - Exports the configuration of a workspace, the platform, or all objects to disk
  • wf follow - Show the status of resources
  • wf get - Retrieves resources
  • wf init - Use wf init to create skeleton YAML structures for Wayfinder resources
  • wf kubeconfig - Adds your workspace provisioned clusters to your kubeconfig
  • wf login - Authenticate yourself and retrieve a token for Wayfinder
  • wf logout - Deletes the login credentials from the current or selected profile
  • wf logs - Retrieves logs from Wayfinder's control plane
  • wf patch - Allows you to patch a resource
  • wf pause - Pauses an element of the system
  • wf profiles - Manage profiles, allowing you to switch, list, and show profiles
  • wf resolve - Resolves a template value from a Wayfinder package or application environment context
  • wf resume - Resumes an element of the system
  • wf search - Used to search for resources
  • wf serverinfo - Retrieves details on the Wayfinder API
  • wf sessions - Session displays assumed sessions
  • wf set - Sets one or more resources
  • wf update - Updates Wayfinder resources
  • wf use - Uses or switches to a resource
  • wf validate - Validates Wayfinder objects
  • wf version - Retrieves the version of the client and server
  • wf wait - Waits for one of more conditions to be met
  • wf whoami - Used to retrieve details on your identity
Last updated