0
# Dagit
1

2
A compatibility package that provides the web UI for Dagster. Dagit serves as a transitional wrapper around the `dagster-webserver` package, maintaining backward compatibility for existing installations while encouraging migration to the newer dagster-webserver package.
3

4
## Package Information
5

6
- **Package Name**: dagit
7
- **Language**: Python
8
- **Installation**: `pip install dagit`
9
- **Python Compatibility**: 3.9, 3.10, 3.11, 3.12, 3.13
10
- **License**: Apache-2.0
11

12
## Core Imports
13

14
```python
15
import dagit
16
```
17

18
For version information:
19

20
```python
21
from dagit import __version__
22
```
23

24
## Basic Usage
25

26
### CLI Usage
27

28
The primary way to use dagit is through its command-line interface:
29

30
```bash
31
# Start the Dagster web UI server
32
dagit
33

34
# Start the debug server
35
dagit-debug
36

37
# Check version
38
dagit --version
39
```
40

41
### Python API Usage
42

43
```python
44
from dagit import __version__
45

46
# Access package version
47
print(f"Dagit version: {__version__}")
48
```
49

50
## Capabilities
51

52
### Version Information
53

54
Access to the package version identifier.
55

56
```python { .api }
57
__version__: str
58
```
59

60
The version string for the dagit package (e.g., "1.11.8").
61

62
### Command Line Interface
63

64
Two console commands are provided for running the Dagster web UI.
65

66
#### Main Web UI Server
67

68
```bash { .api }
69
dagit [options]
70
```
71

72
Starts the Dagster web UI server. This command is a direct delegate to `dagster-webserver.cli:main` - it passes through all arguments and options while showing deprecation warnings directing users to migrate to `dagster-webserver`.
73

74
**Common Options:**
75
- `-f, --python-file`: Python file to load Dagster definitions from
76
- `-m, --module-name`: Python module to load Dagster definitions from
77
- `-a, --attribute`: Attribute in the module to use as the repository
78
- `-w, --working-directory`: Working directory for the command
79
- `-h, --host`: Host to run the web server on
80
- `-p, --port`: Port to run the web server on
81
- `--version`: Show version information
82

83
#### Debug Server
84

85
```bash { .api }
86
dagit-debug [options]
87
```
88

89
Starts the Dagster web UI in debug mode. This command is a direct delegate to `dagster_webserver.debug:main` - it passes through all arguments and options.
90

91
## Types
92

93
```python { .api }
94
__version__: str
95
```
96

97
String constant containing the package version.
98

99
## Package Dependencies
100

101
Dagit has minimal direct functionality and primarily depends on:
102

103
- **dagster-webserver==1.11.8**: Core web server implementation
104
- **dagster_shared.libraries**: For library registration
105

106
## Migration Notes
107

108
This package is a compatibility shim. Users are encouraged to migrate to using `dagster-webserver` directly:
109

110
- Replace `dagit` command with `dagster-webserver` 
111
- Replace `dagit-debug` command with `dagster-webserver --debug`
112
- All functionality remains the same
113

114
## Error Handling
115

116
The CLI commands may raise:
117
- **ImportError**: When dagster-webserver dependencies are not available
118
- **SystemExit**: On invalid command-line arguments or server startup failures
119

120
Version command returns "dagster-webserver, version X.X.X" format and accepts standard dagster arguments for loading definitions.