reubn / autocomplete

Autocomplete for terminals on MacOS

Home Page:https://withfig.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


os Signup Documentation Slack Twitter

Fig adds autocomplete to the terminal. As you type, Fig pops up subcommands, options, and contextually relevant arguments in your existing terminal on macOS.

Fig Visual Autocomplete For Your Terminal Demo

Add a completion spec for a CLI tool

Looking to improve autocomplete functionality or add support for your favorite CLI tool? We welcome contributions for new specs!

Completion specs are defined in a declarative JSON schema, that specifies subcommands, options and arguments. Suggestions can be generated dynamically by running shell commands or reading local files, in addition to the information in the spec itself.

For more documentation and tutorials, visit withfig.com/docs

To request completions for a CLI tool, open an issue.

Linting Your Spec

The autocomplete spec linter can be run to validate the format of completion specs. Run it to get syntax and type errors from your autocomplete spec.

To use the linter, run the following command from the root folder. node linter.js specs/[specName].js

To run the linter on ALL specs in the /specs folder, run node linter.js

FAQ

What terminals does Fig work with?

Fig works with iTerm, the native MacOS Terminal app, Hyper and the integrated terminal in VSCode.

How does Fig work?

Fig uses the Accessibility API on Mac to insert text on your behalf and read the current keybuffer.

Does Fig work on Windows or Linux?

Currently, Fig is only available on MacOS.

How can I get access?

Sign up for the waitlist at withfig.com. Fig is currently in a private beta. We are onboarding batches of new users each week.

Can I use this for internal scripts and CLI tools at my company?

Yes! Check out the autocomplete for teams in our docs. Reach out to hello@withfig.com if you need help.

Did we miss something?

Get in touch at hello@withfig.com or chat with us on Slack

About

Autocomplete for terminals on MacOS

https://withfig.com

License:MIT License


Languages

Language:JavaScript 100.0%Language:Shell 0.0%