Skip to content

Documentation issues around CLI - 0.10 re Learn Doc #883

Description

@leestott

Page https://learn.microsoft.com/en-gb/azure/foundry-local/reference/reference-cli

The cli references are NOT correct..

Current command on 1.10.0 https://github.com/microsoft/Foundry-Local/releases/tag/cli-preview-0.10.0

foundry --help
Description:
Run generative AI models locally, privately, and offline.

Command groups:
Model: model, cache
Run: run, chat, complete, transcribe
Server: server
Setup: config
Help: status, report

Usage:
foundry [command] [options]

Options:
-?, -h, --help Show help and usage information
--version Show version information
-o, --output Output format (text|json). Defaults to text. [default: Text]

Commands:
model - Discover, inspect, download, load, and unload local models
chat - Start an interactive local chat session
complete - Generate one stateless text completion
run - Run a model with automatic routing to chat or transcription
server - Start, stop, restart, inspect, and troubleshoot the local Foundry daemon
cache - Inspect and manage downloaded model cache entries
config - View and edit persistent Foundry CLI settings
status - Show system, service, model, and connectivity diagnostics
report - Open a pre-filled GitHub issue with diagnostics
transcribe - Start an interactive local speech transcription session or transcribe a file

The the page on Learn Docs needs updating

Requirement

Addition of useful commands - 0.10.0 https://github.com/microsoft/Foundry-Local/releases/tag/cli-preview-0.10.0

Add in following suggestion to docs for fixed port setup? On previous versions of the CLI - service configuration through foundry service set commands.

To set a fixed port Pre 0.10.0:

foundry service set --port 12345
foundry service restart

For v > 0.10.0

foundry server start --port 39839 --idle-timeout 0

Then verify:

pre 1.10.0

foundry service status

v> 1.10.0
foundry server status

You should see something similar to:

Service Status: Running
Local Endpoint: http://127.0.0.1:12345

Update Request
Update docs to also include fix port ID and assign IP Binding to a custom port.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions