### Install Rustup on MacOS/Linux (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Installs the Rust toolchain manager, rustup, using a curl command to download and execute the installation script. Follow the on-screen instructions to complete the setup.

```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

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

### Making HTTP GET Request in Shell (Wget)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Provides a simple command-line example using the 'wget' utility to download content from a URL via an HTTP GET request.

```Shell
wget "https://api.example.com/data"
```

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

### Example LLM Prompt for UI Plan

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/Application_NingWei_AI UI Designer for APIs.md

Shows a sample JSON structure used as input for the LLM, containing the task description and the parsed API response schema to guide UI generation.

```JSON
{
  "task": "Generate UI plan for API response",
  "schema": {
    "type": "object",
    "fields": [
      {"name": "username", "type": "string"},
      {"name": "email", "type": "string"},
      {"name": "created_at", "type": "timestamp"}]
  }
}
```

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

### Install Swift Dependencies on Linux (Alamofire) (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Updates the package list and installs necessary system dependencies for Swift development on Linux using `apt-get`, including `clang`, `libicu-dev`, and `libcurl4-openssl-dev`, specifically for Alamofire setup.

```sh
sudo apt-get update
sudo apt-get install clang libicu-dev libcurl4-openssl-dev
```

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

### Example: Running Integration Tests on Windows (Shell)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/integration_testing.md

This is a specific example demonstrating how to run the integration tests on the Windows platform using the runner file.

```shell
flutter test .\integration_test\runner.dart -d windows
```

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

### Install Rust on macOS/Linux (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Execute this command in your terminal on macOS or Linux to download and run the official rustup installer script, which is the recommended way to install Rust.

```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

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

### Example API Key Authentication (Header) in Dart

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Demonstrates how to make an HTTP GET request using API key authentication by including the API key in the `X-API-KEY` header. It shows how to handle the response and check the status code.

```Dart
// APIDash-generated API Key request (header method)
final client = http.Client();
try {
  final response = await client.get(
    Uri.parse('https://api.example.com/data'),
    headers: {
      'X-API-KEY': 'your_api_key',
      'Content-Type': 'application/json',
    },
  ).timeout(const Duration(seconds: 10));
  
  if (response.statusCode == 200) {
    final data = jsonDecode(response.body);
    // Process data
  } else {
    print('Request failed with status: ${response.statusCode}');
  }
} finally {
  client.close();
}
```

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

### Build and Install Arch Linux Package (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Builds the Arch Linux package using the `PKGBUILD` file and then installs it on the system. The `-s` flag syncs dependencies, and `-i` installs the built package.

```bash
makepkg -si
```

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

### Test Homebrew Formula Installation (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Installs the API Dash application using the local Homebrew formula file, building it from the source (or rather, from the tarball specified in the formula). This verifies the installation process defined in the formula.

```bash
brew install --build-from-source Formula/apidash.rb
```

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

### Verify .NET SDK Installation (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Use this command in the terminal to check the installed version of the .NET SDK, confirming a successful installation.

```Bash
dotnet --version
```

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

### Example Digest Authentication Flow in Dart

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

This simplified Dart code snippet illustrates the basic steps involved in performing Digest Authentication. It shows making an initial request to get the challenge, parsing the header (simplified), generating necessary values like cnonce, calculating a placeholder response, and making the final authenticated request. It's presented as a simplified example of generated code.

```Dart
// First request to get the challenge
final client = http.Client();
try {
  // Initial request to get the challenge
  final initialResponse = await client.get(Uri.parse('https://api.example.com/data'));
  if (initialResponse.statusCode != 401) {
    print('Server did not request authentication');
    return;
  }
  
  // Parse the WWW-Authenticate header
  final authHeader = initialResponse.headers['www-authenticate'] ?? '';
  if (!authHeader.toLowerCase().startsWith('digest ')) {
    print('Server does not support digest authentication');
    return;
  }
  
  // Extract digest parameters (simplified)
  final realm = _extractParam(authHeader, 'realm');
  final nonce = _extractParam(authHeader, 'nonce');
  final qop = _extractParam(authHeader, 'qop');
  
  // Generate cnonce and other required values
  final cnonce = _generateCnonce();
  final nc = '00000001';
  
  // Calculate response (simplified)
  // In a real implementation, this would follow RFC 2617 algorithm
  final digestResponse = 'generated_digest_response_here';
  
  // Make authenticated request
  final response = await client.get(
    Uri.parse('https://api.example.com/data'),
    headers: {
      'Authorization': 'Digest username="your_username", realm="$realm", '
          'nonce="$nonce", uri="/data", response="$digestResponse", '
          'qop=$qop, nc=$nc, cnonce="$cnonce"',
      'Content-Type': 'application/json',
    },
  );
  
  if (response.statusCode == 200) {
    // Process successful response
  } else {
    print('Authentication failed: ${response.statusCode}');
  }
} finally {
  client.close();
}
```

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

### Install Apidash using apt (Debian/Ubuntu)

Source: https://github.com/foss42/apidash/blob/main/INSTALLATION.md

Installs the Apidash application on Debian-based Linux distributions using the apt package manager from a local .deb file. Requires superuser privileges. Replace <fullname> with the actual filename.

```Shell
sudo apt install ./apidash-<fullname>.deb
```

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

### Install Flatpak Bundle (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Installs the generated `apidash.flatpak` bundle file for the current user. This makes the application available to run via Flatpak.

```bash
flatpak install --user apidash.flatpak
```

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

### Install PHP and cURL - OpenSUSE

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Install PHP, PHP CLI, and necessary extensions including cURL on OpenSUSE systems using the zypper package manager.

```Bash
sudo zypper install php php-cli php-curl php-mbstring php-xml php-zip
```

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

### Install Apidash using dpkg (Debian/Ubuntu)

Source: https://github.com/foss42/apidash/blob/main/INSTALLATION.md

Installs the Apidash application on Debian-based Linux distributions directly using the dpkg command from a local .deb file. Requires superuser privileges. Replace <fullname> with the actual filename.

```Shell
sudo dpkg -i apidash-<fullname>.deb
```

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

### Example OAuth 1.0 Signature Generation and Request in Dart

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

This Dart code block provides a step-by-step example of generating an OAuth 1.0 signature and constructing the Authorization header. It shows how to set up parameters, create the signature base string, calculate the signature, and make an authenticated HTTP GET request using the generated header. Placeholder values are used for keys, tokens, and URL.

```Dart
import 'dart:convert';
import 'dart:math';
import 'package:crypto/crypto.dart';
import 'package:http/http.dart' as http;
import 'package:collection/collection.dart';

// Generate OAuth 1.0 signature and make request
final String consumerKey = 'your_consumer_key';
final String consumerSecret = 'your_consumer_secret';
final String token = 'your_access_token'; // If available
final String tokenSecret = 'your_token_secret'; // If available

// Generate OAuth parameters
final timestamp = (DateTime.now().millisecondsSinceEpoch ~/ 1000).toString();
final nonce = base64Url.encode(List<int>.generate(16, (_) => Random().nextInt(256))).substring(0, 16);

// Create parameter map
final params = SplayTreeMap<String, String>.from({
  'oauth_consumer_key': consumerKey,
  'oauth_nonce': nonce,
  'oauth_signature_method': 'HMAC-SHA1',
  'oauth_timestamp': timestamp,
  'oauth_token': token, // Include only if available
  'oauth_version': '1.0',
});

// Create signature (simplified)
final signatureBaseString = 'GET&${Uri.encodeComponent('https://api.example.com/data')}&parameter_string_here';
final signingKey = '$consumerSecret&$tokenSecret';
final signature = base64.encode(Hmac(sha1, utf8.encode(signingKey))
    .convert(utf8.encode(signatureBaseString))
    .bytes);

// Create Authorization header
final authHeader = 'OAuth oauth_consumer_key="$consumerKey", '
    'oauth_nonce="$nonce", oauth_signature="$signature", '
    'oauth_signature_method="HMAC-SHA1", oauth_timestamp="$timestamp", '
    'oauth_token="$token", oauth_version="1.0"';

// Make authenticated request
final response = await http.get(
  Uri.parse('https://api.example.com/data'),
  headers: {
    'Authorization': authHeader,
    'Content-Type': 'application/json',
  },
);
```

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

### Verify Rust Installation (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Run these commands in your terminal after installing Rust to confirm that the Rust compiler (rustc) and the Cargo build tool are correctly installed and to check their versions.

```sh
rustc --version
cargo --version
```

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

### Example: Generating and Using JWT for HTTP Request (Dart)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Demonstrates how to generate a JWT token with specific claims and use it to authenticate an HTTP GET request by adding it to the Authorization: Bearer header. Requires `dart:convert`, `package:crypto/crypto.dart`, and `package:http/http.dart`.

```Dart
import 'dart:convert';
import 'package:crypto/crypto.dart';

String generateJwt(String secretKey, Map<String, dynamic> payload) {
  final header = {'alg': 'HS256', 'typ': 'JWT'};
  
  // Encode header and payload
  final encodedHeader = base64Url.encode(utf8.encode(jsonEncode(header)));
  final encodedPayload = base64Url.encode(utf8.encode(jsonEncode(payload)));
  
  // Create signature
  final dataToSign = '$encodedHeader.$encodedPayload';
  final hmac = Hmac(sha256, utf8.encode(secretKey));
  final digest = hmac.convert(utf8.encode(dataToSign));
  final signature = base64Url.encode(digest.bytes);
  
  return '$encodedHeader.$encodedPayload.$signature';
}

// Generate and use JWT token
final claims = {
  'sub': 'user123',
  'name': 'John Doe',
  'iat': DateTime.now().millisecondsSinceEpoch ~/ 1000,
  'exp': DateTime.now().add(Duration(hours: 1)).millisecondsSinceEpoch ~/ 1000
};

final jwt = generateJwt('your_secret_key', claims);

final response = await http.get(
  Uri.parse('https://api.example.com/data'),
  headers: {
    'Authorization': 'Bearer $jwt',
    'Content-Type': 'application/json',
  },
);
```

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

### Example LLM Output for UI Plan

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/Application_NingWei_AI UI Designer for APIs.md

Provides an example of the expected JSON output from the LLM, suggesting the layout structure and details for individual fields like labels and suggested widgets based on the input schema.

```JSON
{
  "layout": "vertical_card",
  "fields": [
    {"label": "Username", "widget": "TextField"},
    {"label": "Email", "widget": "TextField"},
    {"label": "Signup Date", "widget": "DateDisplay"}]
}
```

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

### Setting up and Running API Dash Code in Node.js (JavaScript, Axios)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Details the steps required to set up a Node.js project, install the Axios library, and execute the API Dash generated JavaScript code using Node.js.

```bash
node --version
npm --version
```

```bash
npm init -y
```

```bash
npm install axios
```

```bash
mkdir node-axios-example
cd node-axios-example
```

```bash
npm init -y
```

```bash
node app.js
```

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

### Installing Package using Homebrew

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Installs the 'apidash' package using the Homebrew package manager. Assumes the necessary tap has been added or the formula is in a known repository.

```Shell
brew install apidash
```

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

### Verify Go Installation CLI

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Check the installed version of the Go compiler using the command line.

```bash
go version
```

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

### Run Installed Flatpak Application (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Executes the API Dash application installed via Flatpak using its application ID (`io.github.foss42.apidash`).

```bash
flatpak run io.github.foss42.apidash
```

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

### Verify Swift Installation on Linux (Alamofire) (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Checks the installed version of the Swift compiler on Linux after installation by running the `swift --version` command in the terminal, specifically in the context of setting up for Alamofire.

```sh
swift --version
```

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

### Install PHP and cURL - Ubuntu/Debian

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Install PHP, PHP CLI, and necessary extensions including cURL on Ubuntu or Debian systems using the apt package manager.

```Bash
sudo apt update
sudo apt install php php-cli php-curl php-mbstring php-xml php-zip -y
```

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

### Verify Swift Installation on Linux (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Checks the installed version of the Swift compiler on Linux after installation by running the `swift --version` command in the terminal.

```sh
swift --version
```

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

### Install .NET SDK on Fedora/CentOS (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Execute this command in the terminal on Fedora or CentOS-based Linux distributions to install the .NET SDK version 7.0.

```Bash
sudo dnf install dotnet-sdk-7.0
```

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

### Verify Rust Installation (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Verifies the successful installation of the Rust compiler (`rustc`) and the Cargo build tool by checking their versions in the terminal.

```sh
rustc --version
cargo --version
```

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

### Install Python Requests on Windows (bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Run this command in Command Prompt or PowerShell on Windows to install the 'requests' library for Python using the pip package installer.

```bash
pip install requests
```

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

### Install .NET SDK on Ubuntu/Debian (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Run these commands in the terminal on Ubuntu or Debian-based Linux distributions to update package lists and install the .NET SDK version 7.0.

```Bash
sudo apt update
sudo apt install dotnet-sdk-7.0
```

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

### Install Swift on Linux (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Extracts the downloaded Swift tarball and adds the Swift binary directory to the system's PATH environment variable, making the `swift` command available.

```sh
tar xzf filename
export PATH=$PWD/filename/usr/bin:$PATH
```

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

### Get Melos Package Dependencies

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/setup_run.md

Runs `flutter pub get` or `dart pub get` for all packages managed by Melos within the monorepo, ensuring all package dependencies are fetched and up-to-date.

```bash
melos pub-get
```

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

### Bootstrap Melos Workspace

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/setup_run.md

Initializes the Melos workspace for the API Dash monorepo. This command links local packages together and installs dependencies for all packages within the monorepo.

```bash
melos bootstrap
```

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

### Install Swift on Linux (Alamofire) (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Extracts the downloaded Swift tarball and adds the Swift binary directory to the system's PATH environment variable, making the `swift` command available, specifically in the context of setting up for Alamofire.

```sh
tar xzf filename
export PATH=$PWD/filename/usr/bin:$PATH
```

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

### Performing HTTP GET Request - R (httr)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Shows how to perform an HTTP GET request using the httr package in R. Loads the library, calls the `GET` function, and retrieves the response content.

```R
library(httr)
res <- GET("https://api.example.com/data")
content(res, "text")
```

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

### Example: Running Specific File Tests with Flutter (Flutter/Shell)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/testing.md

An example demonstrating how to run tests for a particular widget test file using the Flutter test command.

```Shell
flutter test test/widgets/codegen_previewer_test.dart
```

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

### Example LLM Prompt for UI Plan Generation (JSON)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/idea_NingWei_AI UI Designer for APIs.md

This JSON snippet demonstrates an example prompt structure sent to an LLM to request a UI plan based on a given API response schema. It includes the task description and the schema representation, which the LLM uses to suggest layout and field mappings.

```json
{
  "task": "Generate UI plan for API response",
  "schema": {
    "type": "object",
    "fields": [
      {"name": "username", "type": "string"},
      {"name": "email", "type": "string"},
      {"name": "created_at", "type": "timestamp"}]
  }
}
```

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

### Install PHP and cURL - Fedora/CentOS

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Install PHP, PHP CLI, and necessary extensions including cURL on Fedora or CentOS systems using the dnf package manager.

```Bash
sudo dnf install php php-cli php-curl php-mbstring php-xml php-zip -y
```

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

### Install Flatpak and Builder (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Installs the Flatpak package manager and the Flatpak Builder tool on Debian/Ubuntu systems. It also adds the Flathub remote repository if it doesn't already exist.

```bash
sudo apt install flatpak
flatpak install -y flathub org.flatpak.Builder
flatpak remote-add --if-not-exists --user flathub https://dl.flathub.org/repo/flathub.flatpakrepo
```

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

### Install PHP and cURL - Arch Linux/Manjaro

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Install PHP, PHP Apache, PHP CGI, and necessary extensions including cURL on Arch Linux or Manjaro systems using the pacman package manager.

```Bash
sudo pacman -S php php-apache php-cgi php-curl php-mbstring php-xml php-zip
```

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

### Installing Chocolatey Package Locally

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Installs a Chocolatey package from a local source (the current directory). Useful for testing the `.nupkg` file before publishing.

```PowerShell
choco install apidash -s .
```

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

### Install Swift Dependencies on Linux (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Updates the package list and installs necessary system dependencies for Swift development on Linux using `apt-get`, including `clang`, `libicu-dev`, and `libcurl4-openssl-dev`.

```sh
sudo apt-get update
sudo apt-get install clang libicu-dev libcurl4-openssl-dev
```

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

### Initialize Swift Executable Package (Alamofire) (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Initializes a new executable Swift package within the current directory using the Swift Package Manager, setting up the basic project structure for an executable application, specifically for Alamofire setup.

```sh
swift package init --type executable
```

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

### Define Homebrew Formula (Ruby)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Defines the Homebrew formula for API Dash. It specifies the application description, homepage, download URL, SHA256 checksum, installation steps (`install` method), and a test command (`test` method).

```ruby
class Apidash < Formula
  desc "Modern API dashboard for developers"
  homepage "https://apidash.dev"
  url "https://github.com/<user>/<repo>/releases/download/v1.0.0/apidash-v1.0.0.tar.gz"
  sha256 "PASTE_YOUR_SHA256_HERE"

  def install
    prefix.install "Apidash.app"
    bin.write_exec_script prefix/"Apidash.app/Contents/MacOS/Apidash"
  end

  test do
    system "#{bin}/Apidash", "--version"
  end
end
```

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

### Performing HTTP GET Request - Perl (LWP::UserAgent)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Shows how to perform an HTTP GET request using the LWP::UserAgent module in Perl. Creates a user agent object, calls the `get` method, and prints the decoded content.

```Perl
use LWP::UserAgent;
my $ua = LWP::UserAgent->new;
my $res = $ua->get("https://api.example.com/data");
print $res->decoded_content;
```

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

### Install Arch Linux Build Dependencies (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Installs the `base-devel` package group required for building packages on Arch Linux, which includes essential tools like `make`, `gcc`, etc.

```bash
sudo pacman -S base-devel
```

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

### Test Installed Homebrew Application (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Runs the test command defined within the Homebrew formula (`test do ... end`). This typically verifies that the installed application can be executed, often by checking its version.

```bash
brew test apidash
```

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

### Performing HTTP GET Request - Haskell (http-client)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Demonstrates an HTTP GET request using the http-client library in Haskell. Sets up a manager, parses the URL, performs the request, and prints the response body.

```Haskell
import Network.HTTP.Client
import Network.HTTP.Client.TLS

main :: IO ()
main = do
  manager <- newManager tlsManagerSettings
  request <- parseRequest "https://api.example.com/data"
  response <- httpLbs request manager
  print $ responseBody response
```

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

### Verify Java Installation

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Command to check the installed Java Development Kit (JDK) version on your system.

```Bash
java -version
```

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

### Verify Swift Installation on macOS (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Checks the installed version of the Swift compiler on macOS by running the `swift --version` command in the terminal.

```sh
swift --version
```

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

### Verify Swift Installation on macOS (Alamofire) (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Checks the installed version of the Swift compiler on macOS by running the `swift --version` command in the terminal, specifically in the context of setting up for Alamofire.

```sh
swift --version
```

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

### Example LLM Output for UI Plan (JSON)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/idea_NingWei_AI UI Designer for APIs.md

This JSON snippet shows an example of the expected JSON output from the LLM after processing a schema prompt. It provides suggestions for the overall layout structure and detailed mappings for individual fields, including suggested labels and corresponding Flutter widgets.

```json
{
  "layout": "vertical_card",
  "fields": [
    {"label": "Username", "widget": "TextField"},
    {"label": "Email", "widget": "TextField"},
    {"label": "Signup Date", "widget": "DateDisplay"}]
}
```

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

### Initializing Melos Workspace (Shell)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/testing.md

Run the Melos bootstrap command to initialize the workspace. This links local packages and installs remaining package dependencies across the monorepo.

```Shell
melos bootstrap
```

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

### Setting up and Running API Dash Code in Java (AsyncHttpClient)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Provides instructions for setting up a Java environment, adding the AsyncHttpClient library using Maven or Gradle, and compiling and running the generated Java code.

```bash
java -version
```

```xml
<dependencies>
  <dependency>
      <groupId>org.asynchttpclient</groupId>
      <artifactId>async-http-client</artifactId>
      <version>3.0.1</version>
  </dependency>
</dependencies>
```

```bash
mvn install
```

```gradle
implementation 'org.asynchttpclient:async-http-client:3.0.1'
```

```bash
gradle build
```

```bash
javac ApiTest.java
```

```bash
java ApiTest
```

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

### Getting Main App Dependencies with Flutter (Flutter/Shell)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/testing.md

Use the standard Flutter pub get command to fetch dependencies specifically for the main application package.

```Shell
flutter pub get
```

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

### Performing HTTP GET Request - Scala (sttp)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Illustrates an HTTP GET request using the sttp client library in Scala. Defines a basic request, sets up a backend, and sends the request.

```Scala
import sttp.client3._
val request = basicRequest.get(uri"https://api.example.com/data")
val backend = HttpURLConnectionBackend()
val response = request.send(backend)
```

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

### Initialize Homebrew Tap Repository (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Creates a new public GitHub repository to serve as a Homebrew tap, clones it locally, creates a `Formula` directory within it, and navigates into the tap directory.

```bash
gh repo create homebrew-tap --public --clone
mkdir -p homebrew-tap/Formula
cd homebrew-tap
```

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

### Get App Dependencies

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/setup_run.md

Fetches all dependencies specifically for the main Flutter application package. This is typically run after cloning the repository or modifying the main `pubspec.yaml` file.

```bash
flutter pub get
```

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

### Install Python 3 on Fedora/CentOS (bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Execute this command in the terminal on Fedora or CentOS systems to install Python 3 using the dnf package manager. Requires superuser privileges.

```bash
sudo dnf install python3
```

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

### Adding Network Client Entitlement (macOS)

Source: https://github.com/foss42/apidash/blob/main/packages/json_explorer/example/README.md

To enable network access for the JSON Explorer example when running on macOS, you must add the 'com.apple.security.network.client' entitlement with a value of 'true' to the application's Debugprofile.entitlements file. This grants the application permission to make outgoing network connections.

```XML
	<key>com.apple.security.network.client</key>
	<true/>
```

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

### Python API Calling Function Example

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/Application_Manas Hejmadi_AI UI Designer For APIs.md

A Python function example demonstrating how to make an API call (POST request) using the 'requests' library. It includes basic error handling and returns the JSON response or an error dictionary.

```python
import requests
def func(data):
	try:
		response = requests.post("...", data=data)
		response.raise_for_status()
		return response.json()
    except requests.exceptions.RequestException as e:
		print(f"Error: {e}")
	return {"error": "An error occurred while calling API"}
```

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

### Setting up and Running API Dash Code in Node.js (JavaScript, Fetch)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Outlines the process for setting up a Node.js project and running API Dash generated JavaScript code using the native Fetch API (Node.js 18+) or the `node-fetch` package.

```bash
node --version
npm --version
```

```bash
npm init -y
```

```bash
npm install node-fetch
```

```bash
mkdir node-fetch-example
cd node-fetch-example
```

```bash
npm init -y
```

```javascript
const fetch = require('node-fetch');
```

```bash
node app.js
```

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

### Fetch Dart Dependencies CLI

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Run the dart pub get command in the terminal to download and link the dependencies listed in pubspec.yaml.

```bash
dart pub get
```

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

### Install Python 3 on Debian/Ubuntu (bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Run these commands in the terminal on Debian or Ubuntu systems to update the package list and install Python 3 using the apt package manager. Requires superuser privileges.

```bash
sudo apt update
sudo apt install python3
```

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

### Fetch Dart Dependencies CLI

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Run the dart pub get command in the terminal to download and link the dependencies listed in pubspec.yaml.

```bash
dart pub get
```

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

### Create New Swift Project Directory (Alamofire) (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Creates a new directory named `URLSessionDemo` for the Swift project and then changes the current terminal directory into it, specifically for Alamofire setup.

```sh
mkdir URLSessionDemo
cd URLSessionDemo
```

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

### Define Insomnia Collection Structure in Dart

Source: https://github.com/foss42/apidash/blob/main/packages/insomnia_collection/README.md

This snippet defines a Dart map that mirrors the structure of an Insomnia collection export JSON. It includes definitions for a workspace, a request group (folder), and several request examples (GET, POST, PUT) with parameters, headers, and body content.

```Dart
import 'package:insomnia_collection/insomnia_collection.dart';

void main() {
   // Example 2: Insomnia collection from JSON
  var collectionJson = {
    "_type": "export",
    "__export_format": 4,
    "__export_date": "2025-01-05T13:05:11.752Z",
    "__export_source": "insomnia.desktop.app:v10.3.0",
    "resources": [
      {
        "_id": "req_15f4d64ca3084a92a0680e29a958c9da",
        "parentId": "fld_a2e9704c49034e36a05cdb3a233f6ebd",
        "modified": 1736112258432,
        "created": 1736111908438,
        "url": "https://food-service-backend.onrender.com/api/users/",
        "name": "get-with-params",
        "description": "",
        "method": "GET",
        "body": {},
        "parameters": [
          {
            "id": "pair_bf0ae4f4280e440a8a591b64fd4ec4f4",
            "name": "user_id",
            "value": "34",
            "description": "",
            "disabled": false
          }
        ],
        "headers": [
          {"name": "User-Agent", "value": "insomnia/10.3.0"}
        ],
        "authentication": {},
        "metaSortKey": -1736111908438,
        "isPrivate": false,
        "pathParameters": [],
        "settingStoreCookies": true,
        "settingSendCookies": true,
        "settingDisableRenderRequestBody": false,
        "settingEncodeUrl": true,
        "settingRebuildPath": true,
        "settingFollowRedirects": "global",
        "_type": "request"
      },
      {
        "_id": "fld_a2e9704c49034e36a05cdb3a233f6ebd",
        "parentId": "wrk_fde7dcc4f5064b74b0fd749cbf8f684a",
        "modified": 1736082089076,
        "created": 1736082089076,
        "name": "APIDash-APItests",
        "description": "These are test endpoints for API Dash",
        "environment": {},
        "environmentPropertyOrder": null,
        "metaSortKey": -1736082080559,
        "preRequestScript": "",
        "afterResponseScript": "",
        "authentication": {},
        "_type": "request_group"
      },
      {
        "_id": "wrk_fde7dcc4f5064b74b0fd749cbf8f684a",
        "parentId": null,
        "modified": 1736082089075,
        "created": 1736082089075,
        "name": "APIDash-APItests",
        "description": "",
        "scope": "collection",
        "_type": "workspace"
      },
      {
        "_id": "req_db3c393084f14369bb409afe857e390c",
        "parentId": "fld_a2e9704c49034e36a05cdb3a233f6ebd",
        "modified": 1736082089077,
        "created": 1736082089077,
        "url": "https://api.apidash.dev/country/codes",
        "name": "test-get",
        "description": "",
        "method": "GET",
        "body": {},
        "parameters": [],
        "headers": [],
        "authentication": {},
        "preRequestScript": "",
        "metaSortKey": -1736082080558,
        "isPrivate": false,
        "afterResponseScript": "",
        "settingStoreCookies": true,
        "settingSendCookies": true,
        "settingDisableRenderRequestBody": false,
        "settingEncodeUrl": true,
        "settingRebuildPath": true,
        "settingFollowRedirects": "global",
        "_type": "request"
      },
      {
        "_id": "req_ba718bbacd094e95a30ef3f07baa4e42",
        "parentId": "fld_a2e9704c49034e36a05cdb3a233f6ebd",
        "modified": 1736082089078,
        "created": 1736082089078,
        "url": "https://api.apidash.dev/case/lower",
        "name": "test-post",
        "description": "",
        "method": "POST",
        "body": {
          "mimeType": "application/json",
          "text": "{\n  \"text\": \"Grass is green\"\n}"
        },
        "parameters": [],
        "headers": [
          {"name": "Content-Type", "value": "application/json"}
        ],
        "authentication": {},
        "preRequestScript": "",
        "metaSortKey": -1736082080557,
        "isPrivate": false,
        "afterResponseScript": "",
        "settingStoreCookies": true,
        "settingSendCookies": true,
        "settingDisableRenderRequestBody": false,
        "settingEncodeUrl": true,
        "settingRebuildPath": true,
        "settingFollowRedirects": "global",
        "_type": "request"
      },
      {
        "_id": "req_24cff90fc3c74e71a567f61d3f8e8cc1",
        "parentId": "fld_a2e9704c49034e71a567f61d3f8e8cc1",
        "modified": 1736082089078,
        "created": 1736082089078,
        "url": "https://reqres.in/api/users/2",
        "name": "test-put",
        "description": "",
        "method": "PUT",
        "body": {
          "mimeType": "application/json",
          "text":
              "{\n    \"name\": \"morpheus\",\n    \"job\": \"zion resident\"\n}"
        },
        "parameters": [],
        "headers": [
          {"name": "Content-Type", "value": "application/json"}
        ],
        "authentication": {},
        "preRequestScript": "",
        "metaSortKey": -1736082080556,
        "isPrivate": false,
        "afterResponseScript": "",
        "settingStoreCookies": true
      }
    ]
  };
}
```

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

### Install RestSharp NuGet Package CLI

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Add the RestSharp package dependency to the .NET project using the .NET CLI.

```bash
dotnet add package RestSharp
```

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

### Example Bearer Token Authentication in Dart

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Demonstrates how to make an HTTP GET request using Bearer token authentication by including the token in the `Authorization: Bearer` header. It shows how to handle the response, including checking for success status codes and specifically handling a 401 Unauthorized error.

```Dart
final client = http.Client();
try {
  final response = await client.get(
    Uri.parse('https://api.example.com/data'),
    headers: {
      'Authorization': 'Bearer your_access_token',
      'Content-Type': 'application/json',
    },
  ).timeout(const Duration(seconds: 15));
  
  if (response.statusCode >= 200 && response.statusCode < 300) {
    final responseData = jsonDecode(response.body);
    // Process response data
  } else if (response.statusCode == 401) {
    // Handle token expiration
    print('Token expired. Please refresh authentication.');
  } else {
    print('Request failed with status: ${response.statusCode}');
  }
} finally {
  client.close();
}
```

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

### Creating GitHub Release using gh CLI

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Uses the GitHub CLI (`gh`) to create a new release with a specific tag and attach a tarball asset. Requires the `gh` CLI to be installed and authenticated.

```Shell
gh release create v1.0.0 apidash-v1.0.0.tar.gz
```

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

### Install Python Requests on macOS/Linux (bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Use this command in the terminal on macOS or Linux to install the 'requests' library for Python 3 using the pip3 package installer.

```bash
pip3 install requests
```

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

### Python API Tool Format (Anthropic/OpenAI)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/Application_Manas Hejmadi_AI UI Designer For APIs.md

Example structure for defining an API tool in Python, compatible with frameworks like Anthropic, Mistral, Gemini, and OpenAI. It includes the function definition and the tool's metadata (name, description, parameters).

```python
def func(...):
	#Provided API being called in the language specific way
	
api_tool = {
	"function": func,
	"definition": {
		"name": TOOL_NAME,
		"description": TOOL_DESCRIPTION,
		"parameters": {
			"type": "object",
			"properties": {
				ARG_NAME: {
					"type": ARG_TYPE,
					"description": ARG_DESC
				},
			   ...
			},
			"required": [ALL_REQUIRED_ARGUMENT_NAMES],
			"additionalProperties": False #Anthropic Specific
		}
	}
}

__all__ = ["api_tool"] #Export the Tool
```

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

### Performing HTTP GET Request - Elixir (HTTPoison)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Demonstrates a simple HTTP GET request using the HTTPoison library in Elixir. The `get!` function performs the request and raises an error on failure.

```Elixir
HTTPoison.get!("https://api.example.com/data")
```

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

### Create New Rust Project (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Creates a new executable Rust project named `ureq-demo` using the Cargo build tool. This command sets up the basic project structure.

```sh
cargo new ureq-demo
```

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

### Initialize Go Module CLI

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Create a new Go module for the project using the go mod init command.

```bash
go mod init example.com/api
```

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

### Create C# Console Project via CLI (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Use these commands to create a new C# console application project named 'HttpClientExample' and navigate into its directory using the .NET CLI.

```Bash
dotnet new console -n HttpClientExample
cd HttpClientExample
```

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

### Tapping Homebrew Formula Repository

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Adds a custom Homebrew tap (repository) to the user's Homebrew installation. This allows installing formulas not included in the main Homebrew core.

```Shell
brew tap homebrew-tap/Formula
```

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

### Initializing Chocolatey Package Skeleton

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Uses the `choco new` command to create the basic file structure and template files for a new Chocolatey package. Specifies package name, version, maintainer, and repository.

```PowerShell
choco new --name="apidash" --version="0.3.0" maintainername="foss42" maintainerrepo="https://github.com/foss42/apidash" --built-in-template
```

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

### Initializing mem0_dart Memory Object (Dart)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/idea_udhay_adithya_mem0.md

Demonstrates how to initialize the `Memory` object from the `mem0_dart` library. It shows both default initialization and custom configuration options for vector stores (like Qdrant), LLMs (like OpenAI), and embedding models (like OpenAI). Requires the `mem0_dart` package.

```Dart
import 'package:mem0_dart/mem0_dart.dart';

void main() async {
  // Initialize Mem0 with default configurations or custom settings
  final memory = Memory(); // Using default configurations

  // Or with custom configurations (example - Qdrant vector store)
  final memoryWithQdrant = Memory(
    vectorStoreConfig: VectorStoreConfig(
      provider: 'qdrant',
      config: {
        'collection_name': 'my_flutter_memories',
        'embedding_model_dims': 1536, // Example dimension
        'path': '/path/to/qdrant/db', // Example path for local Qdrant
      },
    ),
    llmConfig: LlmConfig( // Example - OpenAI LLM for memory processing
      provider: 'openai',
      config: {
        'model': 'gpt-4o-mini',
        'apiKey': 'YOUR_OPENAI_API_KEY',
      },
    ),
    embedderConfig: EmbedderConfig( // Example - OpenAI Embedding model
      provider: 'openai',
      config: {
        'model': 'text-embedding-3-small',
        'apiKey': 'YOUR_OPENAI_API_KEY',
      },
    ),
  );

  // ... rest of your Flutter app code
}
```

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

### Initialize Swift Executable Package (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Initializes a new executable Swift package within the current directory using the Swift Package Manager. This sets up the basic project structure for an executable application.

```sh
swift package init --type executable
```

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

### Making HTTP GET Request in Erlang (httpc)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Shows how to perform an HTTP GET request using Erlang's built-in 'httpc' module. It makes a request to a specified URL.

```Erlang
httpc:request(get, {"https://api.example.com/data", []}, [], []).
```

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

### Making HTTP GET Request in Lua (LuaSocket)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Demonstrates how to make a simple HTTP GET request using the LuaSocket library. It requires the 'socket.http' module. The response is printed to the console.

```Lua
local http = require("socket.http")
local response = http.request("https://api.example.com/data")
print(response)
```

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

### Performing HTTP GET Request - TypeScript (Axios)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Shows how to perform a basic HTTP GET request using the Axios library in TypeScript. Imports the library and calls the `axios.get` method.

```TypeScript
import axios from "axios";
axios.get("https://api.example.com/data");
```

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

### Configure Flutter Project Platforms

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/setup_run.md

Configures the Flutter project to support specific desktop or mobile platforms (windows, macos, linux, android, ios) based on the development environment. Replace <platform> with the desired target platform.

```bash
flutter create --platforms=<platform> .
```

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

### Build Flatpak Package (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Uses `flatpak-builder` to construct the Flatpak application based on the provided manifest (`apidash-flatpak.yaml`). It then creates a single `.flatpak` bundle file from the built repository.

```bash
flatpak run org.flatpak.Builder --force-clean --sandbox --user --install --install-deps-from=flathub --ccache --mirror-screenshots-url=https://dl.flathub.org/media/ --repo=repo builddir apidash-flatpak.yaml

flatpak build-bundle repo apidash.flatpak io.github.foss42.apidash
```

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

### Create New Rust Project (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Use this command with Cargo to create a new directory for a Rust binary project, setting up the basic file structure.

```sh
cargo new reqwest-demo
```

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

### Build and Run Go Program CLI

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Compile and execute the main Go program file using the go run command.

```bash
go run main.go
```

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

### Performing HTTP GET Request - TypeScript (Fetch API)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Illustrates a simple HTTP GET request using the native Fetch API in TypeScript. Calls the global `fetch` function with the target URL.

```TypeScript
fetch("https://api.example.com/data");
```

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

### Create Flatpak Manifest File (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Creates an empty file named `apidash-flatpak.yaml` in the project root directory. This file will contain the manifest defining how the Flatpak package is built.

```bash
touch apidash-flatpak.yaml
```

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

### Performing HTTP GET Request - Scala (Akka HTTP)

Source: https://github.com/foss42/apidash/blob/main/doc/proposals/2025/gsoc/application_nikhil_apiauth_and_features.md

Demonstrates an HTTP GET request using the Akka HTTP library in Scala. Creates an HttpRequest object with the target URI and sends it using `Http().singleRequest`.

```Scala
import akka.http.scaladsl.Http
import akka.http.scaladsl.model._
Http().singleRequest(HttpRequest(uri = "https://api.example.com/data"))
```

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

### Build Rust Project Dependencies (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Compiles the project's dependencies, including the newly added `ureq` crate, and checks the project code for errors without producing an executable. This fetches and builds required libraries.

```sh
cargo build
```

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

### Build Flutter Project for macOS (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Builds the Flutter project specifically for the macOS platform. This generates the `.app` bundle required for packaging with Homebrew.

```bash
flutter build macos
```

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

### Parsing and Formatting a GET cURL Command with Headers in Dart

Source: https://github.com/foss42/apidash/blob/main/packages/curl_parser/README.md

This snippet demonstrates parsing a GET cURL command that includes a custom header using the `-H` flag. It parses the string, accesses the `method`, `uri`, and `headers` properties, and then formats the object back into a cURL string, showing how headers are represented in the parsed object and the generated command.

```dart
import 'package:curl_parser/curl_parser.dart';

void main() {
  final curlHeadersStr = 'curl -H "X-Header: Test" https://api.apidash.dev/';
  final curlHeader = Curl.parse(curlHeadersStr);

  // Access parsed data
  print(curlHeader.method);
  // GET
  print(curlHeader.uri);
  // https://api.apidash.dev/
  print(curlHeader.headers);
  // {"X-Header": "Test"}

  // Object to cURL command
  final formattedCurlHeaderStr = curlHeader.toCurlString();
  print(formattedCurlHeaderStr);
  // curl "https://api.apidash.dev/" \
  //  -H "X-Header: Test"
}
```

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

### Parsing and Formatting a Basic GET cURL Command in Dart

Source: https://github.com/foss42/apidash/blob/main/packages/curl_parser/README.md

This snippet demonstrates parsing a simple GET cURL command string into a `Curl` object using `Curl.parse()`. It then accesses the parsed `method` and `uri` properties and formats the `Curl` object back into a cURL string using `toCurlString()`. The output shows the parsed properties and the generated cURL string.

```dart
import 'package:curl_parser/curl_parser.dart';

void main() {
  final curlGetStr = 'curl https://api.apidash.dev/';
  final curlGet = Curl.parse(curlGetStr);

  // Parsed data
  print(curlGet.method);
  // GET
  print(curlGet.uri);
  // https://api.apidash.dev/

  // Object to cURL command
  final formattedCurlGetStr = curlGet.toCurlString();
  print(formattedCurlGetStr);
  // curl "https://api.apidash.dev/"
}
```

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

### Build Rust Project (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Use this command with Cargo to compile your Rust project and download/build any necessary dependencies defined in your Cargo.toml file.

```sh
cargo build
```

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

### Check PHP Version - Command Line

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Verify the installed PHP version by executing this command in the terminal.

```Bash
php --version
```

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

### Uninstall Flatpak Application (Bash)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md

Removes the API Dash application installed via Flatpak using its application ID.

```bash
flatpak uninstall io.github.foss42.apidash
```

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

### Execute Kotlin Code - Command Line

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Compile a Kotlin file into an executable JAR including the runtime, and then run the compiled JAR from the command line.

```Bash
kotlinc api_test.kt -include-runtime -d api_test.jar
java -jar api_test.jar
```

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

### Check Python Version (bash)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Use this command in the terminal to verify if Python 3 is installed on your system and display its version.

```bash
python3 --version
```

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

### Run Flutter Project

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/setup_run.md

Executes the Flutter application on the currently selected target device or emulator. This command compiles and launches the app for local development and testing.

```bash
flutter run
```

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

### Run Swift Project (sh)

Source: https://github.com/foss42/apidash/blob/main/doc/user_guide/instructions_to_run_generated_code.md

Builds and executes the Swift project using the Swift Package Manager. This command compiles the source files and runs the executable.

```sh
swift run
```

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

### Getting Package Dependencies with Melos (Shell)

Source: https://github.com/foss42/apidash/blob/main/doc/dev_guide/testing.md

Execute the Melos pub-get command to fetch all dependencies for the individual packages within the monorepo.

```Shell
melos pub-get
```