0
# Typer CLI
1

2
Empty legacy compatibility package for Typer CLI functionality. This package provides no direct functionality and exists solely as a migration path for old projects that used to depend on `typer-cli`. All CLI functionality has been integrated into the main `typer` package.
3

4
## Package Information
5

6
- **Package Name**: typer-cli
7
- **Package Type**: PyPI  
8
- **Language**: Python
9
- **Installation**: `pip install typer-cli` (⚠️ **Deprecated** - use `pip install typer` instead)
10

11
## Core Imports
12

13
⚠️ **Important**: The `typer-cli` package provides **no direct imports or API**. It is an empty package that only installs the `typer` package as a dependency.
14

15
```python
16
# typer-cli provides NO direct imports
17
# All functionality comes from the typer dependency:
18
import typer  # This import works because typer-cli installs typer as dependency
19
```
20

21
## Basic Usage
22

23
Since `typer-cli` is an empty compatibility wrapper with no API, all usage comes through the `typer` package that it installs as a dependency:
24

25
```python
26
import typer  # Available because typer-cli installs typer
27

28
app = typer.Typer()
29

30
@app.command()
31
def hello(name: str):
32
    """Say hello to someone."""
33
    typer.echo(f"Hello {name}")
34

35
if __name__ == "__main__":
36
    app()
37
```
38

39
The only practical effect of installing `typer-cli` is that it makes the `typer` command-line tool available:
40

41
```bash
42
# Run a Typer app
43
typer my_app.py run
44

45
# Generate docs for a Typer app  
46
typer my_app.py utils docs
47

48
# Show help
49
typer --help
50
```
51

52
## Migration Notice
53

54
⚠️ **This package is deprecated and should not be used for new projects.**
55

56
**Migration path:**
57
```bash
58
# Instead of:
59
pip install typer-cli
60

61
# Use:
62
pip install typer
63
```
64

65
The `typer` package now includes all CLI functionality that was previously in `typer-cli`.
66

67
## Architecture
68

69
The `typer-cli` package has no architecture of its own. It consists of:
70
- A single README.md file explaining the deprecation
71
- Package metadata that declares `typer` as a dependency
72
- No source code, classes, functions, or modules
73

74
## Capabilities
75

76
### Dependency Installation
77

78
The sole capability of `typer-cli` is installing the `typer` package as a dependency.
79

80
```python { .api }
81
# typer-cli provides NO direct API
82
# It only ensures that this import works:
83
import typer
84
```
85

86
### Command Line Tool Access
87

88
When `typer-cli` is installed, it provides access to the `typer` CLI command through the dependency relationship:
89

90
```bash
91
# Available after installing typer-cli (but actually provided by typer)
92
typer [PATH_OR_MODULE] [OPTIONS] COMMAND [ARGS]...
93
```
94

95
The CLI provides these commands:
96
- `run` - Run the provided Typer app
97
- `utils docs` - Generate Markdown documentation for a Typer app
98

99
## Types
100

101
```python { .api }
102
# typer-cli defines NO types
103
# All types come from the typer dependency:
104
# See typer package documentation for complete type definitions
105
```
106

107
## Conclusion
108

109
The `typer-cli` package is an empty legacy compatibility wrapper with **zero direct functionality**. It exists only to install the `typer` package as a dependency. Users should migrate to using `typer` directly for all CLI development needs.