Skip to content

fix(docs): Always include --model flag in quickstart command #95

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

Closed
edenreich wants to merge 1 commit into from
Closed

fix(docs): Always include --model flag in quickstart command #95

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
7 changes: 4 additions & 3 deletions internal/templates/common/docs/README.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,15 @@ docker run -p {{ .ADL.Spec.Server.Port | default 8080 }}:{{ .ADL.Spec.Server.Por

Add this agent to your Inference Gateway CLI:

**Note:** Port {{ .ADL.Spec.Server.Port | default 8080 }} might be reserved on your system. If you encounter conflicts, use an available port (e.g., 8081, 8082) and update the command accordingly.

```bash
infer agents add {{ .ADL.Metadata.Name }} {{ .ADL.Spec.Server.Scheme | default "http" }}://localhost:{{ .ADL.Spec.Server.Port | default 8080 }}{{- if and .ADL.Spec.SCM (eq .ADL.Spec.SCM.Provider "github") .ADL.Spec.SCM.URL }} \
{{- $url := .ADL.Spec.SCM.URL | trimSuffix ".git" | trimPrefix "https://github.com/" | trimPrefix "[email protected]:" }}
--oci ghcr.io/{{ $url }}:latest \
{{- end }}
--run{{- if and .ADL.Spec.Agent .ADL.Spec.Agent.Model }} \
--model {{ .ADL.Spec.Agent.Provider }}/{{ .ADL.Spec.Agent.Model }}
{{- end }}
--run \
--model {{ if and .ADL.Spec.Agent .ADL.Spec.Agent.Provider .ADL.Spec.Agent.Model }}{{ .ADL.Spec.Agent.Provider }}/{{ .ADL.Spec.Agent.Model }}{{ else }}openai/gpt-4o-mini{{ end }}
```

## Features
Expand Down