GitHub - withfig/autocomplete: Fig adds autocomplete to your terminal.

https://github.com/withfig/autocomplete/ • Nov 18, 2021 17:12

Extracto

Fig adds autocomplete to your terminal. Contribute to withfig/autocomplete development by creating an account on GitHub.

Resumen

Resumen Principal

Fig representa una innovadora solución tecnológica diseñada para mejorar significativamente la experiencia de uso de los terminales mediante la implementación de funcionalidades de autocompletado inteligente. Esta herramienta, alojada en la plataforma GitHub bajo el repositorio withfig/autocomplete, se posiciona como un recurso valioso para desarrolladores y profesionales de sistemas que buscan optimizar su productividad en entornos de línea de comandos. El proyecto no solo ofrece una funcionalidad avanzada de autocompletado, sino que también fomenta activamente la colaboración comunitaria al permitir contribuciones externas mediante la creación de cuentas en GitHub. Esta aproximación colaborativa y open-source convierte a Fig en una plataforma en constante evolución, adaptándose a las necesidades cambiantes del ecosistema de desarrollo moderno. La integración nativa con terminales existentes permite a los usuarios beneficiarse de sugerencias contextuales y completado automático de comandos, argumentos y parámetros, transformando una tarea potencialmente tediosa en una experiencia fluida y eficiente.

Elementos Clave

Funcionalidad de Autocompletado: Fig implementa un sistema avanzado de autocompletado contextual que sugiere comandos, argumentos y parámetros en tiempo real, mejorando significativamente la eficiencia terminal
Plataforma GitHub: El proyecto está alojado en GitHub como withfig/autocomplete, proporcionando infraestructura robusta para desarrollo colaborativo y control de versiones
Modelo Open-Source: La herramienta opera bajo una licencia colaborativa que permite contribuciones externas, fomentando una comunidad activa de desarrolladores que mejoran continuamente la funcionalidad
Accesibilidad de Contribución: Cualquier usuario puede participar en el desarrollo creando una cuenta en GitHub, democratizando el proceso de mejora y expansión de las capacidades de autocompletado

Análisis e Implicaciones

La implementación de autocompletado inteligente en terminales representa una transformación significativa en la productividad de desarrolladores, reduciendo errores de sintaxis y acelerando la ejecución de comandos complejos. Esta herramienta tiene el potencial de estandarizar nuevas expectativas de usabilidad en interfaces de línea de comandos, influyendo en el diseño futuro de terminales modernos. La naturaleza colaborativa del proyecto asegura una evolución continua adaptada a las demandas específicas de diferentes entornos de desarrollo y tecnologías emergentes.

Contexto Adicional

Fig se presenta como parte de una tendencia creciente hacia herramientas de desarrollo más intuitivas e inteligentes, alineándose con el movimiento general de mejora de experiencia de usuario en entornos tradicionalmente técnicos. La disponibilidad pública del código fuente en GitHub no solo garantiza transparencia técnica, sino que también facilita la auditoría de seguridad y personalización por parte de organizaciones que requieren soluciones específicas para sus flujos de trabajo.

Contenido

Fig adds autocomplete to your terminal.

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

👋 Add a completion spec for a CLI tool

Want to add autocomplete to a CLI tool (or make changes to an existing autocomplete spec)? We welcome contributions!

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

For documentation and tutorials, visit fig.io/docs.

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

😎 Get Started

Build your first spec in 3 min or less: fig.io/docs/getting-started

Prerequisites:

Early access to the Fig macOS app.

If you don't have access yet, sign up for the waitlist and say you're interested in building completions!
Node and NPM (or Yarn).

Setup:

Click here to fork this repo.
Clone your forked repo and create an example spec

# Replace `YOUR_GITHUB_USERNAME` with your own github username
git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git fig-autocomplete
cd fig-autocomplete

# Add withfig/autocomplete as a remote
git remote add upstream https://github.com/withfig/autocomplete.git

# Install packages
npm install

# Create an example spec (call it "abc")
npm run create-spec abc

# Turn on "dev mode"
npm run dev

Now go to your terminal and type abc[space]. Your example spec will appear. 😊

Other things to know

Edit your spec in typescript in the src/ folder
On save, specs are compiled to the build/ folder
In dev mode specs are read from the build folders. Otherwise they are read from ~/.fig/autocomplete

📦 Other available package.json commands

# Typecheck all specs in the src/ folder
npm test

# Compile typescripts specs from src/ folder to build/ folder
npm run build

# Copy all specs from the build/ folder to the ~/.fig/autocomplete folder
npm run copy:all

# Copy an individual spec from the build/ folder to the ~/.fig/autocomplete folder
npm run copy <spec-name>

We would love contributions for

any other completion spec for CLI tools you use regularly
generators for existing specs

Never submitted a PR before? Check out our How to Contribute guide. Many of Fig's 100+ contributors made their first open source contribution to Fig too!

😊 Need Help?

Join our community

🙋‍♀️ 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 position the window, insert text on your behalf, and read what you've typed in your terminal.

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 fig.io. Fig is currently in a private beta. We are onboarding batches of new users each week.

Can I use Fig to build autocomplete for my team's internal scripts and CLI tools?

Yes! Check out our guide on how to get started building autocomplete specs.

Did we miss something?

Get in touch at hello@fig.io or chat with us in Discord.

Absortio