From e2aa1aec2cdd70dd7156d86e15eb6cdae989142f Mon Sep 17 00:00:00 2001 From: JingliangGao <1121861747@qq.com> Date: Tue, 30 Jun 2026 18:06:19 +0800 Subject: [PATCH] docs: remove deprecated 'run' and 'auth' CLI commands from docs These CLI commands have been removed from fenn but their documentation pages were still referenced in mkdocs.yml. Closes pyfenn/fenn#199 --- mkdocs.yml | 2 - src/content/cli/auth.md | 82 ----------------------------------- src/content/cli/run.md | 96 ----------------------------------------- 3 files changed, 180 deletions(-) delete mode 100644 src/content/cli/auth.md delete mode 100644 src/content/cli/run.md diff --git a/mkdocs.yml b/mkdocs.yml index 183851e..a165a8a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,12 +51,10 @@ nav: - Data Processing: - Tabular: content/user_guide/data_processing/tabular.md - CLI: - - Auth: content/cli/auth.md - Dashboard: content/cli/dashboard.md - Grid: content/cli/grid.md - List: content/cli/list.md - Pull: content/cli/pull.md - - Run: content/cli/run.md - Community: - Contributing: content/community/contributing.md - Code of Conduct: content/community/code_of_conduct.md diff --git a/src/content/cli/auth.md b/src/content/cli/auth.md deleted file mode 100644 index 214309f..0000000 --- a/src/content/cli/auth.md +++ /dev/null @@ -1,82 +0,0 @@ -# Auth - -The `fenn auth` command allows you to manage credentials for the Fenn remote service. -## Usage - -```bash -fenn auth [login] [--profile] [--api-key] [status] [--profile] [logout] [--profile] -``` - -### Arguments -One of subcomand (login, status or logout) is required for `auth` command - -- `[login]`: Save an API key for a profile -- `[--api-key]` (optional): API key (if omitted, will prompt or read from stdin) -- `[--profile]` (optional): Profile name (default: 'default') -- `[status]`: Show the currently configured profile and credit balance -- `[--profile]` (optional): Show the currently configured profile and credit balance -- `[logout]`: Save an API key for a profile -- `[--profile]` (optional): Save an API key for a profile - -## Examples - -### Basic Usage - -Execute fenn app with cartesian product, specified in grid: - -```bash -fenn auth login -``` - -### Login -Save an API key for a profile - -```bash -fenn auth login -``` - -### Specify API key - -Specify API key: - -```bash -fenn auth login --api-key sk-proj-xK9mP2vL8nQrT5wY1jB6cD4eF7gH0iJ3kMnOpQrStUv -``` - -### Set profile - -Credentials profile name (default: 'default' or $FENN_PROFILE). - -```bash -fenn run login --profile test_profile -``` - -### Show status -Show the currently configured profile and credit balance - -```bash -fenn auth status -``` - -### Set profile - -Credentials profile name (default: 'default' or $FENN_PROFILE). - -```bash -fenn run status --profile test_profile -``` - -### Logout -Remove a profile from the credentials file - -```bash -fenn auth logout -``` - -### Set profile - -Credentials profile name (default: 'default' or $FENN_PROFILE). - -```bash -fenn run logout --profile test_profile -``` diff --git a/src/content/cli/run.md b/src/content/cli/run.md deleted file mode 100644 index 4b3b929..0000000 --- a/src/content/cli/run.md +++ /dev/null @@ -1,96 +0,0 @@ -# Run - -The `fenn run` command allows you run a Fenn project on the Fenn remote service - -## Usage - -```bash -fenn run [script] [--api-key] [--profile] [--max-runtime] [--detach] [--no-download] [--include] [--exclude] -``` - -### Arguments - -- `[script]` (optional): Path to the entrypoint script (default: main.py). -- `[--api-key]` (optional): API key (overrides env, credentials file, and .env). -- `[--detach]` (optional): Submit the job and exit without streaming logs. -- `[--exclude]` (optional): Extra shell-glob pattern to exclude from the upload tarball. -- `[--include]` (optional): Extra path (relative to CWD) to include in the upload tarball. -- `[--max-runtime]` (optional): Maximum allowed wall-time in minutes (server enforces; default: 10). -- `[--no-download]` (optional): Do not download artifacts on completion. -- `[--profile]` (optional): Credentials profile name (default: 'default' or $FENN_PROFILE). - - - -## Examples - -### Basic Usage - -Execute on the Fenn remote service; uploads the project, streams logs, downloads artifacts - -```bash -fenn run -``` - -### Specify path to entrypoint script - -Specify path to entrypoint script (default `main.py`): - -```bash -fenn run /my_dir/custom_main.py -``` - -### Specify API key - -Specify API key (overrides env, credentials file, and .env): - -```bash -fenn run --api-key sk-proj-xK9mP2vL8nQrT5wY1jB6cD4eF7gH0iJ3kMnOpQrStUv -``` - -### Specify logs policy - -Submit the job and exit without streaming logs: - -```bash -fenn run --detach -``` - -### Exclude shell-glob pattern - -Extra shell-glob pattern to exclude from the upload tarball: - -```bash -fenn run --exclude file* -``` - -### Include shell-glob pattern - -Extra path (relative to CWD) to include in the upload tarball. - -```bash -fenn run --include file* -``` - -### Set maximum allowed wall-time in minutes - -Maximum allowed wall-time in minutes (server enforces; default: 10). - -```bash -fenn run --max-runtime 20 -``` - -### Exclude artifacts - -Do not download artifacts on completion - -```bash -fenn run --no-download -``` - -### Set profile - -Credentials profile name (default: 'default' or $FENN_PROFILE). - -```bash -fenn run --profile test_profile -``` \ No newline at end of file