{"id":18293771,"url":"https://github.com/withfig/autocomplete-boilerplate","last_synced_at":"2025-04-05T11:31:18.075Z","repository":{"id":44735892,"uuid":"355188374","full_name":"withfig/autocomplete-boilerplate","owner":"withfig","description":"Boilerplate for private CLIs","archived":false,"fork":false,"pushed_at":"2022-01-27T20:33:12.000Z","size":107,"stargazers_count":5,"open_issues_count":1,"forks_count":6,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-21T03:34:41.513Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/withfig.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2021-04-06T12:55:16.000Z","updated_at":"2024-08-24T23:39:38.000Z","dependencies_parsed_at":"2022-09-07T15:12:27.376Z","dependency_job_id":null,"html_url":"https://github.com/withfig/autocomplete-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/withfig","download_url":"https://codeload.github.com/withfig/autocomplete-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247330693,"owners_count":20921682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T14:26:05.134Z","updated_at":"2025-04-05T11:31:17.733Z","avatar_url":"https://github.com/withfig.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg width=\"300\" src=\"https://github.com/withfig/fig/blob/main/static/FigBanner.png?raw=true\"/\u003e\n\u003c/p\u003e\n\n---\n\n![os](https://img.shields.io/badge/os-%20macOS-light)\n[![Signup](https://img.shields.io/badge/signup-private%20beta-blueviolet)](https://fig.io?ref=github_autocomplete)\n[![Documentation](https://img.shields.io/badge/documentation-black)](https://fig.io/docs/)\n![Discord](https://img.shields.io/discord/837809111248535583?color=768ad4\u0026label=discord)\n[![Twitter](https://img.shields.io/twitter/follow/fig.svg?style=social\u0026label=Follow)](https://twitter.com/intent/follow?screen_name=fig)\n\n# Autocompletion Boilerplate\n\nThis repository is a template for **individuals / teams looking to build autocomplete specs for private CLIs and scripts** (ie scripts that they do not want to make public).\n\nThis repo is almost exactly the same as [withfig/autocomplete](https://github.com/withfig/autocomplete) except the `dev/` and `specs/` folders are empty (they will appear after you run `npm run create-boilerplate`)\n\n## Documentation\n\n- Main docs: [fig.io/docs](https://fig.io/docs/)\n- Autocomplete for personal shortcuts: [fig.io/docs/tutorials/visual-shortcuts](https://fig.io/docs/tutorials/visual-shortcuts)\n- Autocomplete for teams: [fig.io/docs/tutorials/building-internal-clis](https://fig.io/docs/tutorials/building-internal-clis)\n\n## Using this repo\n\nBuild your first spec in \u003c 3 min: [fig.io/docs/getting-started](https://fig.io/docs/getting-started)\n\n1. Click \"**Use this Template**\" above. Name it `fig-autocomplete-private`\n\n2. Clone your forked repo and create an example spec\n\n```bash\n# Replace `YOUR_GITHUB_USERNAME` with your own github username\ngit clone https://github.com/YOUR_GITHUB_USERNAME/fig-autocomplete-private.git fig-autocomplete-private\ncd fig-autocomplete-private\n\n# Add withfig/autocomplete as a remote\ngit remote add upstream https://github.com/withfig/autocomplete-boilerplate.git\n\n# Install packages\nnpm install\n\n# Create an example spec (call it \"abc\")\nnpm run create-example\n\n# Turn on \"dev mode\"\nnpm run dev\n```\n\n3. Now go to your terminal and type `abc[space]`. Your example spec will appear. 😊\n\n#### Other things to know\n\n- Edit your spec in typescript in the `dev/` folder\n- On save, specs are compiled to the `specs/` folder\n- In **dev mode** specs are read from the `specs` folders. Otherwise they are read from `~/.fig/autocomplete`\n\n\u003cbr/\u003e\n\n## Save My Spec for Personal use\n\nCompile your spec then save it to your `~/.fig/autocomplete` folder\n\n```bash\n# Compile your spec(s) to the specs/ folder\nnpm run build\n\n# Copy your spec from the specs/ folder to the ~/.fig/autocomplete folder\nnpm run copy \u003cspec-name\u003e\n```\n\n## Share my Spec with My Team\n\nCompile your spec(s) to the `specs/` folder\n\n```bash\n# Compile your spec\nnpm run build\n\n# Commit your changes and push to your repo\ngit add .\ngit commit -m \"my message\"\ngit push origin master\n```\n\nNow have your team clone your repo and then copy all the specs over to their ~/.fig/autocomplete folder\n\n```\ngit clone https://github.com/YOUR_GITHUB_USERNAME/fig-autocomplete-private.git fig-autocomplete-private\ncd fig-autocomplete-private\n\n# Copy all specs from the specs/ folder to the ~/.fig/autocomplete folder\nnpm run copy:all\n```\n\n**Alternatively**, you can simply share your compiled `.js` file with anyone (e.g. through email or Slack). Once they put the file in their `~/.fig/autocomplete` folder, it will start working!\n\n\u003e **Note**: Fig is working on providing a much better experience for sharing specs with your team. We are hoping to launch it very soon.\n\n## Other available package.json commands\n\n```bash\n\n# Create a new spec from a boilerplate template\nnpm run create-boilerplate\n\n# Typecheck all specs in the dev/ folder\nnpm test\n\n# Compile typescripts specs from dev/ folder to specs/ folder\nnpm run build\n\n# Copy all specs from the specs/ folder to the ~/.fig/autocomplete folder\nnpm run copy:all\n\n# Copy an individual spec from the specs/ folder to the ~/.fig/autocomplete folder\nnpm run copy \u003cspec-name\u003e\n```\n\n## 😊 Need Help?\n\nEmail [hello@fig.io](mailto:hello@fig.io)\n\n\u003cp align=\"center\"\u003e\n    Join our community\n\u003cbr/\u003e\n\u003ca href=\"https://fig.io/community\"\u003e\n    \u003cimg src=\"http://fig.io/icons/discord-logo-square.png\" width=\"80px\" height=\"80px\" /\u003e \n\u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithfig%2Fautocomplete-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwithfig%2Fautocomplete-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithfig%2Fautocomplete-boilerplate/lists"}