Tour the TUI¶
In this tutorial you launch the alis TUI, walk through its screens with the keyboard, build one of your services and watch the build run, read its logs, and quit. At the end you know where everything is and how to get back. It is for builders who prefer a screen to a prompt.
You need the CLI installed and signed in (Install the CLI), and access to a product with at least one service. The key names below are case-sensitive: B and ShiftB do different things.
1. Launch¶
The TUI fills the terminal. The title bar reads Home; the body says "Pick a build environment to start building." and lists your build environments. The footer reads:
On first launch a short Tour opens instead. Press Enter to page through it or Esc to skip; you can replay it any time with ShiftG.
2. Learn the footer¶
The footer is your map. Filled key badges are this page's actions; the quiet items after them are always there: S specialist, Esc back, Q quit, and . for more.
Press .. A centred menu titled Home shortcuts lists every other key on this page and then the app-wide keys, sorted by key. Move with Up/Down and press Enter to run one, or press Esc to close it. You can also press any listed key directly while the menu is open.
3. Open a build environment¶
Move to a build environment with J/K (or the arrow keys) and press Enter.
The title becomes Build environment with the build environment's id, and the body lists its products. The footer shows Enter open · o quick open · y copy path · u share.
4. Open a product¶
Select a product and press Enter.
The title becomes Product with <org>.<product>. The body is a grid: services run down the first column; every further column is a deployment environment. Move with H/J/K/L.
With a service selected in the first column the footer reads:
Move right with L onto a deployment environment cell and it changes to:
Move back left with H onto the service.
5. Start a build¶
With the service selected, press B.
A panel opens in the centre: select the commit to build, then, if it asks, the images to rebuild, and the build starts. The panel shows the operation's steps and a log tail, and a row appears in the notification strip under the frame. The panel's hints read Esc background · l logs · w hide · y copy.
Press Esc. The panel closes but the build keeps running: the strip row stays, with its elapsed time ticking and the hint W open. This is how you carry on working while operations run.
6. Watch it finish¶
Press ShiftW to reopen the panel whenever you like. When the build completes the row reads · done and the panel hint changes to enter close. If the terminal was not focused, a desktop notification tells you.
Press L in the panel to open the full build log in your browser, then Enter to close the panel.
If the build fails, the row reads · failed at <step>.
7. Find it again later¶
Press ShiftN. The Activity page lists recent activity, newest first. Select the build and press Enter to expand its details, L to view its logs, Y to copy. Press ShiftN again to go back.
8. Look at the deployment environment¶
Press L to select a deployment environment cell and press E.
The Environment variables editor opens: one row per variable, one column per deployment environment. Press A to add a variable, Enter to edit a value, S to save, or ShiftE to close without saving. Close it now.
Still on the deployment environment cell, press ShiftE. The ENVIRONMENT OPTIONS menu offers "Set active deployment environment", "Rename deployment environment" and "Designated branches". Choose Set active deployment environment: it writes the deployment environment's variables and credentials to the product's .alis/.env, which M (run the service locally) and alis run load. Press Esc to leave the menu.
9. Ask for help¶
Press S. The Build specialist page lists your support conversations; + starts a new one and Enter opens one. Press S again to return.
Press A. The Ask page answers questions from your own sessions, conversations and skills: press /, type a question, press Enter, then 1 to 9 to open a cited source. Press A again to return.
10. Quit¶
Press Q. The TUI closes and the terminal prints a one-line sign-off, for example:
What you have¶
- You know the footer, the . shortcuts menu and Esc to go back.
- You opened a build environment, a product and its grid, and started a build from the B key.
- You backgrounded an operation with Esc, reopened it with ShiftW, read its logs with L and found it again under ShiftN.
- You know where environment variables (E), the active deployment environment (ShiftE), support (S) and Ask (A) live.
For what a build is and where its version goes next, read Define, Build, Deploy.