User Guide¶

Home > User Guide

Welcome to the Ingenious Fabric Accelerator User Guide! This section provides comprehensive information on how to use the tool effectively for your Microsoft Fabric projects.

What You'll Learn¶

This guide covers everything you need to know to get started and become proficient with the Ingenious Fabric Accelerator:

Installation¶

• System requirements
• Installation methods
• Environment setup
• Verification steps

Quick Start¶

• Your first project
• Basic commands
• Common workflows
• Tips for success

CLI Reference¶

• Complete command reference
• Options and parameters
• Usage examples
• Best practices

Workflows¶

• Development workflow
• Deployment strategies
• Testing approaches
• Troubleshooting

DBT Integration¶

• Automatic profile management
• Lakehouse selection
• Creating notebooks from dbt
• Best practices

Common Tasks¶

• Quick reference for frequently used commands
• Step-by-step guides for common operations
• Command examples with explanations
• Tips and tricks

Environment Variables¶

• Configuration variables reference
• Authentication settings
• Workspace configuration
• Runtime environment settings

Workspace Layout¶

• Project structure overview
• Directory organization
• File naming conventions
• Best practices

Prerequisites¶

Before using the Ingenious Fabric Accelerator, ensure you have:

• Python 3.12 (Recommended)
• Access to a Microsoft Fabric workspace
• Basic understanding of SQL and Python
• Familiarity with command-line tools

Getting Help¶

If you need assistance:

1. Check this documentation - Most questions are answered here
2. Use the built-in help - Run ingen_fab --help for command-specific help
3. Review examples - Check the Examples section
4. Contact your administrator - For workspace or access issues

Quick Navigation¶