Fluttium

https://fluttium.dev
Admin
Fluttium is a user flow testing tool for Flutter applications that simulates real user interactions...
Tokens:4,188
Snippets:56
Trust Score:6.1
Update:8 months ago
Show doc for...
Tokens:
Raw
### Verify Fluttium CLI Installation

Source: https://fluttium.dev/docs/getting-started/installing-cli

After activating the `fluttium_cli`, run this command in your terminal to verify the installation. It should display the Fluttium version and usage information, confirming that the CLI is ready to use.

```bash
Fluttium, a user flow testing tool for Flutter.  
  
Usage: fluttium <command> [arguments]  
  
Global options:  
-h, --help            Print this usage information.  
-v, --version         Print the current version.  
    --[no-]verbose    Noisy logging, including all shell commands executed.  
  
Available commands: ...
```

--------------------------------

### Fluttium CLI Installation and Usage

Source: https://fluttium.dev/docs/why-fluttium

This snippet shows the basic command-line interface (CLI) commands for Fluttium. It covers installing the Fluttium CLI from pub.dev, creating a new test flow file, and running an existing test flow file. These commands are essential for setting up and executing tests.

```bash
# 📦 Install from pub.dev  
flutter pub global activate fluttium_cli  

# 🖥 Create a test flow file  
fluttium new flow my_flow --description "My cool flow"  

# 🧪 Run a test flow file  
fluttium test my_flow.yaml  

```

--------------------------------

### Install Fluttium CLI from pub.dev

Source: https://fluttium.dev/docs/getting-started/installing-cli

This command activates the `fluttium_cli` package globally using the Flutter package manager. Ensure you have the Flutter SDK installed before running this command. The output confirms the successful installation.

```bash
# 📦 Install from pub.dev
flutter pub global activate fluttium_cli
```

--------------------------------

### Example Fluttium Flow File Structure

Source: https://fluttium.dev/docs/getting-started/creating-a-flow-test

An example of a `my_flow.yaml` file generated by Fluttium. It includes a description and a simple log step. Flows are defined as a sequence of steps.

```yaml
description: My first Fluttium flow.
---
- log: 'Hello World!'
```

--------------------------------

### Example User Flow Test in Fluttium

Source: https://fluttium.dev/docs/why-fluttium

This example demonstrates a user flow test written in Fluttium's declarative YAML syntax. It simulates searching for weather information in Chicago, including pressing buttons, writing text, and verifying visibility. This format is designed for readability and ease of understanding.

```yaml
description: Find the weather in Chicago  
---
- pressOn: Search
- pressOn: City
- writeText: Chicago
- pressOn: Submit
- expectVisible: Chicago  

```

--------------------------------

### Get Help for Fluttium Test Command

Source: https://fluttium.dev/docs/getting-started/testing-a-first-flow-test

Displays the help information for the 'fluttium test' command, outlining all available options and their usage. This command is essential for understanding how to override settings in the 'fluttium.yaml' file and customize test execution.

```bash
fluttium test --help
```

--------------------------------

### Add Custom Action from pub.dev (YAML)

Source: https://fluttium.dev/docs/actions/custom

This snippet shows how to declare a custom action named 'log_action' with version '0.2.0' in the `fluttium.yaml` file. Fluttium will automatically fetch and install this action from pub.dev during testing.

```yaml
actions:  
  log_action: 0.2.0  

```

--------------------------------

### Display Help for New Action Command (CLI)

Source: https://fluttium.dev/docs/actions/custom

This CLI command displays the help information and available options for the `fluttium new action` command. It is useful for understanding all the parameters and flags that can be used to customize the generation of a new action.

```bash
fluttium new action --help  

```

--------------------------------

### View Fluttium Flow Command Options

Source: https://fluttium.dev/docs/getting-started/creating-a-flow-test

To see all available options for the `fluttium new flow` command, use the `--help` flag. This will display detailed information about customizing the flow generation process.

```bash
fluttium new flow --help
```

--------------------------------

### Tap/Click with pressOn Action in YAML

Source: https://fluttium.dev/docs/actions/built-in/interactions

The `pressOn` action allows tapping or clicking on specific widgets within the application. It can find widgets by semantic labels or visible text, and optionally tap at a specific offset. The shorthand syntax defaults to text search.

```yaml
- pressOn:
    text: 'Your Text'
    offset: [10, 150]

```

```yaml
- pressOn: 'Your Text'

```

--------------------------------

### Add Custom Action from Git or Local Path (YAML)

Source: https://fluttium.dev/docs/actions/custom

This YAML snippet demonstrates how to add custom actions from a Git repository or a local filesystem path. For Git, specify the URL and the path within the repository. For local paths, provide the relative or absolute path to the action's directory.

```yaml
actions:  
  # From GIT:  
  log_action:  
    git:  
      url: https://github.com/wolfenrain/fluttium.git  
      path: actions/log_action  
  # Or from path:  
  log_action:  
    path: ../path/to/log_action  

```

--------------------------------

### Execute a Fluttium Flow Test

Source: https://fluttium.dev/docs/getting-started/testing-a-first-flow-test

Runs a specified flow file using the 'fluttium test' command. This command reads the 'fluttium.yaml' configuration, applies it to the driver, and executes the flow. The output indicates the success or failure of each step in the flow.

```bash
fluttium test my_flow.yaml
```

--------------------------------

### Wait Action Configuration (YAML)

Source: https://fluttium.dev/docs/actions/built-in/advanced

Configures the 'wait' action in Fluttium using full YAML syntax, specifying time units like days, hours, minutes, seconds, milliseconds, and microseconds. This action is a last resort for timed delays.

```yaml
- wait:  
    days: 1 # why would you do this?  
    hours: 1  
    minutes: 2  
    seconds: 50  
    milliseconds: 500  
    microseconds: 50  

```

--------------------------------

### Wait Action Shorthand (YAML)

Source: https://fluttium.dev/docs/actions/built-in/advanced

Provides the shorthand syntax for the 'wait' action in Fluttium, allowing for a quick specification of a delay in milliseconds. This is a simpler alternative for basic timed waits.

```yaml
- wait: 500 # By default it uses milliseconds  

```

--------------------------------

### Generate New Fluttium Flow Test

Source: https://fluttium.dev/docs/getting-started/creating-a-flow-test

Use the `fluttium new flow` command to create a new flow test file. This command takes the desired flow name as an argument and generates a corresponding YAML file with a basic structure.

```bash
fluttium new flow <flow-name>
```

--------------------------------

### Swipe with swipe Action in YAML

Source: https://fluttium.dev/docs/actions/built-in/interactions

The `swipe` action facilitates horizontal swiping within a widget. It requires specifying the widget to swipe in and the target widget to swipe until. Supported directions are left and right, with configurable timeouts and speeds. Regex patterns can be used for `in` and `until` parameters.

```yaml
- swipe:
    in: 'Your List View'
    until: 'Your List Item'
    direction: right
    timeout: 5000
    speed: 10

```

--------------------------------

### Take Screenshot with Fluttium (YAML)

Source: https://fluttium.dev/docs/actions/built-in/debugging

The `takeScreenshot` action captures a full screenshot and saves it to a specified file. It supports an optional `pixelRatio` argument, defaulting to the device's pixel ratio. A shorthand syntax is also available.

```yaml
- takeScreenshot:
    path: 'path/to/screenshot.png'
    pixelRatio: 1.5 # Defaults to device pixel ratio.
```

```yaml
- takeScreenshot: 'path/to/screenshot.png'
```

--------------------------------

### Generate New Custom Action (CLI)

Source: https://fluttium.dev/docs/actions/custom

This command-line interface (CLI) command generates a new custom action for Fluttium. Replace `<action-name>` with the desired name for your action. This command scaffolds the necessary files and directory structure for a new action package.

```bash
fluttium new action <action-name>  

```

--------------------------------

### Long Press with longPressOn Action in YAML

Source: https://fluttium.dev/docs/actions/built-in/interactions

The `longPressOn` action simulates a long press on a widget. Similar to `pressOn`, it can identify widgets by text or semantic labels and supports an optional offset. The shorthand syntax uses text search.

```yaml
- longPressOn:
    text: 'Your Text'
    offset: [10, 150]

```

```yaml
- longPressOn: 'Your Text'

```

--------------------------------

### Scroll with scroll Action in YAML

Source: https://fluttium.dev/docs/actions/built-in/interactions

The `scroll` action enables scrolling within a specified widget, such as a list view, until a target widget is found. It supports various directions (up, down, left, right, top), custom timeouts, and scroll speeds. The `in` and `until` parameters can use regex patterns.

```yaml
- scroll:
    in: 'Your List View'
    until: 'Your List Item'
    direction: up
    timeout: 5000
    speed: 10

```

--------------------------------

### Expect Visible Element (YAML)

Source: https://fluttium.dev/docs/actions/built-in/expectations

Checks if a specific text is visible within the application's semantic tree. It searches semantic labels, tooltips, and text nodes. Supports text regular expressions and optional timeouts.

```yaml
- expectVisible:
    text: 'Your Text'
    timeout: 100
```

```yaml
- expectVisible: 'Your Text'
```

--------------------------------

### Write Text with Fluttium

Source: https://fluttium.dev/docs/actions/built-in/text

The `writeText` action appends a given string to the current text value, simulating user input. It takes the text to be written as its argument.

```yaml
- writeText: 'Your Text'
```

--------------------------------

### Watch for Changes During Fluttium Flow Test

Source: https://fluttium.dev/docs/getting-started/testing-a-first-flow-test

Executes a flow test and continuously watches for changes in the flow file or the Flutter project. Detected changes trigger a hot reload, allowing for iterative testing. This is useful for rapid development and debugging.

```bash
fluttium test my_flow.yaml --watch
```

--------------------------------

### Expect Not Visible Element (YAML)

Source: https://fluttium.dev/docs/actions/built-in/expectations

Checks if a specific text is NOT visible within the application's semantic tree. It verifies the absence of semantic labels, tooltips, and text nodes. Supports text regular expressions and optional timeouts.

```yaml
- expectNotVisible:
    text: 'Your Text'
    timeout: 100
```

```yaml
- expectNotVisible: 'Your Text'
```

--------------------------------

### Clear Text with Fluttium

Source: https://fluttium.dev/docs/actions/built-in/text

The `clearText` action simulates a user deleting text character by character. It can optionally clear a specified number of characters or clear all text if no count is provided.

```yaml
- clearText:
    characters: 100
```

```yaml
- clearText:
```
Tokens:
Raw