Installation#

Get FlowKit up and running in minutes with these simple installation methods.

Install from Source#

For local development or customization:

# Clone the repository
git clone https://github.com/ansys/aali-flowkit.git
cd aali-flowkit

# Run FlowKit
go run main.go

Note

Make sure you have Go 1.21+ installed.

Basic Configuration#

FlowKit works out of the box with default settings. For custom configuration:

  1. Copy the example configuration:

    cp configs/config.yaml config.yaml

    copy configs\config.yaml config.yaml

  2. Modify only what you need. Most users only need to set:

    FLOWKIT_API_KEY: "your-api-key"  # Optional, for authentication

For advanced configuration options, see Configuration.

Verify Installation#

FlowKit is running successfully when you see:

{"level":"info","msg":"Aali FlowKit started successfully; gRPC server listening on address 'localhost:50051.'"}

Quick Test#

Test FlowKit is working by listing available functions using grpcurl:

# Install grpcurl
brew install grpcurl

# List available functions
grpcurl -plaintext localhost:50051 list

# Install grpcurl
curl -sSL https://github.com/fullstorydev/grpcurl/releases/download/v1.8.7/grpcurl_1.8.7_linux_x86_64.tar.gz | tar xz
sudo mv grpcurl /usr/local/bin/

# List available functions
grpcurl -plaintext localhost:50051 list

:: Download grpcurl from GitHub releases:
:: https://github.com/fullstorydev/grpcurl/releases
:: Or use WSL with Linux instructions

:: List available functions
grpcurl -plaintext localhost:50051 list

Troubleshooting#

If FlowKit fails to start:

  1. Check error.log in the root folder

  2. Verify all required configuration values are set

  3. Ensure the port 50051 is not in use

  4. Check service endpoint connectivity

Next Steps#

Back to Getting started