Skip to content

Document custom CLI arguments collision #822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jourdain merged 1 commit into from
Nov 3, 2025
Merged

Document custom CLI arguments collision #822

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/vitepress/guide/intro/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,10 +197,17 @@ from trame.app import get_server
server = get_server()

server.cli.add_argument("-d", "--data", help="Directory to explore", dest="data")
args = server.cli.parse_args()
args = server.cli.parse_known_args()[0]
print(args.data)
```

Note that if you intend to use your own CLI parser or rely on a library which parses CLI arguments,
you need to make sure that the arguments are not overlapping with the trame server ones.
In case of CLI arguments overlapping and still requiring to pass arguments to trame server's, it is
recommended to use either the `--trame-args` flag (eg. `--trame-args="-p 1000"`) or the `TRAME_ARGS` environment variable,
which have a higher priority over CLI arguments.


## Starting an application

The server provides a `start()` method which actually starts a trame application. Typically the following section is placed in the main script:
Expand Down