Documentation Index
Fetch the complete documentation index at: https://docs.fusioncat.dev/llms.txt
Use this file to discover all available pages before exploring further.
Fusioncat is currently in its alpha stage. The main API server is located at:
https://api.staging.fusioncatalyst.io/Please note that breaking changes and bugs are to be expected, as the product is still under active development.
Settings Initialization
The paw init-settings-file command creates a local configuration file for your FusionCatalyst project.
Command
paw init-settings-file [options]
Options
--server: Server URL (default: https://api.fusioncat.dev)
--language: Default code generation language
typescript
python
java
go
Examples
# Basic initialization
paw init-settings-file
# Custom server and language
paw init-settings-file --server https://api.fusioncat.dev --language typescript
# Local development server
paw init-settings-file --server http://localhost:8080 --language go
Settings File
The command creates a fcsettings.yaml file in your current directory:
syntax_version: 1
server: https://api.fusioncat.dev
code_generation:
output_folder: generated
language: go
class_suffix: FCModel
File Location
- Created in: Current working directory
- File name:
fcsettings.yaml
- Git: Usually added to
.gitignore for user-specific settings
Configuration Options
server
The FusionCatalyst API server URL:
- Production:
https://api.fusioncat.dev
- Staging:
https://staging-api.fusioncat.dev
- Local:
http://localhost:8080
language
Default language for code generation:
typescript - For Node.js, React, Angular, Vue
python - For Django, FastAPI, Flask
java - For Spring Boot, Micronaut
go - For Go backend applications
Workflows
New Project Setup
# 1. Initialize settings
paw init-settings-file --language typescript
# 2. Authenticate
paw auth signin --email you@example.com --password yourpass
# 3. Create project
paw projects new --name "My API"
Team Collaboration
For team projects, each member:
# 1. Clone repository
git clone https://github.com/team/project
# 2. Initialize their own settings
cd project
paw init-settings-file
# 3. Authenticate with their credentials
paw auth signin --email member@team.com --password theirpass
Environment Variables
Settings can be overridden with environment variables:
# Override server URL
export FC_SERVER_URL="https://custom.fusioncat.dev"
# Override default language
export FC_LANGUAGE="python"
# Set authentication token
export FC_ACCESS_TOKEN="your-auth-token"
Priority order:
- Command line flags
- Environment variables
- Settings file
- Default values
Multiple Projects
Managing multiple projects in different directories:
# Project A
cd ~/projects/api-a
paw init-settings-file
# Project B
cd ~/projects/api-b
paw init-settings-file
# Each directory has its own settings
Best Practices
Git Configuration
Add to .gitignore:
# Fusioncat settings
fcsettings.yaml
# But track a template
fcsettings.yaml.example
Create fcsettings.yaml.example:
syntax_version: 1
server: https://api.fusioncat.dev
code_generation:
output_folder: generated
language: go
class_suffix: FCModel
Security
- Never commit: Authentication tokens or sensitive data
- Use environment: For CI/CD authentication
- Personal settings: Each developer has their own file
Team Setup
Document in your README:
## Setup
1. Initialize your settings:
```bash
paw init-settings-file --language typescript
-
Authenticate:
paw auth signin --email your@email.com --password yourpass --save-token
-
Generate code:
paw codegen app --app-id "app-uuid"
## Troubleshooting
### Settings Not Found
```bash
Error: No settings file found
Solution:
# Create settings file
paw init-settings-file
Server Connection
Error: Cannot connect to server
Solution:
# Check server URL
cat fcsettings.yaml
# Update if needed
paw init-settings-file --server https://api.fusioncat.dev