Does cspell work locally or is anything sent externally?

[kieran-lowe]

Just curious if I use this, the CLI, from NPM etc if it all works locally on the machine or is any data sent externally (such as the words) to a server?

Say for example if this was to be used in an air gapped environment.

[Jason3S]

@kieran-lowe,

The CLI is 100% standalone. Given that, if you include a remote dictionary in your configuration, it will need to fetch it.

[kieran-lowe]

Thanks @Jason3S! When you say "remote directory", I assume you mean importing say another configuration from somewhere else? Or referring to any additional dictionaries from the dicts repo?

For context I was being asked if this tool sends anything outside the system being ran on for security reasons.

[Jason3S]

@kieran-lowe,

By design, the CLI should never send out any information. If it does, then I would consider it a bug and a security issue.

By default, all cspell dictionaries are installed locally. But you can tell the spell checker to use a remote word list:

local/cspell.config.yaml

dictionaryDefinitions:
  - name: company-terms
    path: https://my.company.com/info/company-terms.txt
dictionaries:
  - company-terms

or a remote configuration:

local/cspell.config.yaml

import:
  - https://my.company.com/development/shared/cspell.json