Skip to content

docs: add import command usage#586

Open
leno23 wants to merge 1 commit into
lmstudio-ai:mainfrom
leno23:docs/import-command-554
Open

docs: add import command usage#586
leno23 wants to merge 1 commit into
lmstudio-ai:mainfrom
leno23:docs/import-command-554

Conversation

@leno23

@leno23 leno23 commented Jun 14, 2026

Copy link
Copy Markdown

Summary

  • add lms import <file path> to the README command list
  • document importing local model files and the default move behavior
  • include examples for --copy, --hard-link, --symbolic-link, --user-repo, --yes, and --dry-run

Closes #554

Tests

  • README import docs assertions against src/subcommands/importCmd.ts
  • git diff --check
  • npx prettier --check README.md

@github-actions

Copy link
Copy Markdown


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8ef2603296

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +77 to +80
For unattended usage, add `--yes` to approve prompts automatically. To preview the target action without changing files, use `--dry-run`:

```shell
lms import ~/Downloads/model.gguf --yes --dry-run

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Avoid documenting --yes --dry-run as unattended

For a fresh profile using the default move mode, this documented unattended preview can still block and change local state: importCmd.action calls warnAboutMove(logger, yes, ...) before the dry-run branch, and warnAboutMove still calls confirm(...) even when yes is true; resolveModelsFolderPath also creates the models folder before --dry-run is checked. Users following this README example in CI or scripts can hang on the first-run move warning instead of getting a non-interactive preview, so the docs need to avoid this claim/example unless the implementation is changed.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Add lms import documentation to README - not documented here

1 participant