Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Using the BinaryCircuits App

This chapter explains how to use the BinaryCircuits terminal app (TUI) as an end user. The aim is that you can install it, log in, browse the marketplace, purchase workflows, and manage your library without needing separate support.

You do not need to know anything about Rust or the internal services to follow this guide.

Starting the App

Once you have installed the BinaryCircuits user application (typically a standalone executable named tui_user), you can start it from your terminal:

tui_user

If tui_user is not found, ensure it’s in your system’s PATH or specify the full path to the executable.

You will see:

  • A login / registration screen on first run.
  • A simple navigation bar that lets you switch between:
    • Browse – see workflows in the marketplace.
    • Search – (future) search by keyword.
    • Cart – view and manage workflows you plan to purchase.
    • Library – view workflows you own (once implemented).
    • Account – view your tier and licences (once implemented).

The exact keybindings are shown in the footer at the bottom of each screen, but the core navigation is consistent:

  • q or Esc – quit the app (or exit confirmation dialogs).
  • Number keys 1–5 – jump to main sections (Browse, Search, Cart, Library, Account) where enabled.
  • b or Backspace – go “back” from details to the previous screen.

Logging In and Registering

On the login screen you can:

  • Log in with an existing email and password.
  • Register a new account if you do not have one yet.

Switching Between Login and Register

  • Press Tab to toggle between Login and Register modes.
  • The form fields update to show what is needed (email, username, password).

Moving Between Fields

  • Use the arrow keys:
    • ↑ and ↓ to move between fields (Email, Username, Password).

Entering Your Details

  • Type as you would in a normal text field:
    • Characters appear in the active field.
    • Backspace deletes the last character.

Submitting the Form

  • Press Enter to submit either the login or registration form.
  • The app will:
    • Contact the BinaryCircuits API.
    • Create an account (for registration) or verify your credentials (for login).
    • Store a session file at ~/.matrixforge/session.json so you stay logged in next time.

If login/registration succeeds:

  • You are taken straight to the Browse screen.
  • Your subscription tier is stored in the session and used to determine which workflows and prices you see.

If there is an error (wrong password, connection problem, etc.):

  • An error message appears at the bottom of the screen.
  • You can correct the fields and press Enter again.

Logging Out

From any screen where a logout option is available (e.g., in the footer or Account screen), you can use it to securely end your session.

If you ever need to manually clear your session data, for example, if you are experiencing persistent login issues or need to log out from all devices, you can delete the session file:

rm ~/.matrixforge/session.json

Browsing the Marketplace

After logging in, you will usually start on the Browse screen.

The Browse screen shows:

  • A paginated list of workflows, with each item displaying:
    • Name.
    • Price in £GBP.
    • Tier (for example, Free, Hobbyist, Pro).
    • Category.
    • Node count and complexity score.
    • Average rating and number of reviews.
    • Whether the workflow is ready to be compiled (“Compilable ✓”).

Interpreting Workflow Information

  • Node count and complexity score: Generally, a higher node count and complexity score indicate a more intricate workflow, potentially offering more powerful or specialized automation.
  • Average rating and number of reviews: These help you gauge a workflow’s quality and reliability based on community feedback.
  • ↑ / k – move selection up.
  • ↓ / j – move selection down.
  • PageUp – go to the previous page.
  • PageDown – go to the next page.
  • Enter or v – view details for the selected workflow.
  • a – add the selected workflow to your cart.
  • 3 – jump to the Cart screen.
  • q – quit the app.

If you encounter issues connecting to the marketplace, ensure your internet connection is active. If problems persist, please contact support.

Viewing Workflow Details

From the Browse screen:

  • Select a workflow and press Enter or v to open the Workflow Details screen.

The details screen shows:

  • Name and price.
  • Tier and category.
  • Rating and number of reviews.
  • Number of nodes and complexity score.
  • A description of what the workflow does.
  • A list of key node types used.
  • Whether the workflow is compilable and the approximate binary size.

Key actions:

  • a – add the workflow to your cart (if you have not already).
  • p – add to cart and jump straight to the Cart screen.
  • b or Backspace – go back to Browse.
  • q – quit the app.

Use this screen to decide whether a workflow matches your needs before purchasing.

Using the Cart

The Cart screen shows all workflows you plan to purchase.

From Browse or Details:

  • Press a to add a workflow to your cart.
  • Press 3 to go directly to the Cart.

In the Cart screen you can:

  • See each workflow name and price.
  • See the total amount in £GBP.

Navigation and actions:

  • ↑ / k – move up through items.
  • ↓ / j – move down through items.
  • d or Delete – remove the selected item.
  • Ctrl+C – clear the entire cart.
  • Enter or p – proceed to checkout.
  • b – go back to Browse.

Checkout Flow

When you press Enter or p:

  1. A confirmation dialog appears showing:
    • Number of workflows.
    • Total price in £GBP.
    • Your current subscription tier.
  2. Press y or Enter to confirm, or n/Esc to cancel.
  3. On success:
    • Licences are created for each workflow.
    • A success dialog appears summarising the purchase.
  4. From the success dialog:
    • Press Enter or l to go to Library (once implemented).
    • Press b to go back to Browse.

If the API reports an error (for example, payment failure), the error text is shown and the cart remains unchanged so you can try again later.

Library and Account Screens (Upcoming)

The app will soon include fully functional:

  • Library:
    • This screen will display all workflows you own, allowing you to filter by compilation status and view basic runtime information.
    • You will be able to manage your downloaded and compiled binaries from here.
  • Account:
    • This screen will show your current subscription tier, basic account information, and a list of active licences tied to your account.

In early versions, these screens may show “Not yet implemented” messages as their functionality is being finalized. For now, your purchases and licences are securely stored and enforced on the server side.

Keyboard Shortcuts Summary

For quick reference, and as always, remember to check the help text in the footer of the current screen as it always summarises the most important keys for that specific context.

  • Global

    • q, Esc – quit.
    • b, Backspace – back to previous screen or browse.
    • 1–5 – jump between main sections (Browse, Search, Cart, Library, Account) where implemented.

  • Login/Register

    • Tab – toggle login/register mode.
    • ↑ / ↓ – move between fields.
    • Enter – submit.

  • Browse

    • ↑ / k – move up.
    • ↓ / j – move down.
    • PageUp / PageDown – change page.
    • Enter / v – view details.
    • a – add to cart.

  • Details

    • a – add to cart.
    • p – add to cart and go to cart.
    • b – back to browse.

  • Cart

    • ↑ / k, ↓ / j – navigate items.
    • d / Delete – remove selected item.
    • Ctrl+C – clear cart.
    • Enter / p – checkout.
    • b – back to browse.