https://github.com/solidjs-community/solid-cli

A custom CLI built for Solid.
https://github.com/solidjs-community/solid-cli

Last synced: about 1 month ago
JSON representation

A custom CLI built for Solid.

• Host: GitHub
• URL: https://github.com/solidjs-community/solid-cli
• Owner: solidjs-community
• License: mit
• Created: 2023-07-08T18:01:12.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-21T21:04:02.000Z (5 months ago)
• Last Synced: 2024-04-22T01:19:33.739Z (5 months ago)
• Language: TypeScript
• Homepage: https://solid-cli.netlify.app/
• Size: 10.1 MB
• Stars: 54
• Watchers: 2
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



> [!WARNING]

> This project is under heavy development and is not yet complete. More features coming soon!

# Solid CLI

[![Build and Test](https://github.com/solidjs-community/solid-cli/actions/workflows/tests.yml/badge.svg)](https://github.com/solidjs-community/solid-cli/actions/workflows/tests.yml)

[![Netlify Status](https://api.netlify.com/api/v1/badges/5233ac74-3f53-4c90-b95d-25b528b931a1/deploy-status)](https://app.netlify.com/sites/solid-cli/deploys)

A custom-built CLI for creating and managing SolidJS apps and projects.

## Roadmap/Features

- [x] Templates

  - [x] From Degit

- [x] Docs

- [ ] Primitives

  - [ ] Add/remove/update primitives

  - [x] Search list of primitives

- [ ] Integrations

  - [ ] Auth.js

  - [x] Tailwind

  - [ ] PandaCSS

  - [ ] Cypress

  - [ ] PostCSS

  - [x] UnoCSS

  - [ ] Vanilla Extract

  - [x] Vitest

  - [x] Tauri

  - [ ] Playwright

- [ ] Utilities

  - [ ] eslint-plugin-solid

  - [x] solid-devtools

- [ ] Misc

  - [x] Launch new Stackblitz

  - [ ] Launch new CodeSandBox

- [x] SolidStart

  - [x] New route

  - [x] New data file

  - [x] Enable Adapters

  - [x] Enable SSR/CSR/SSG mode

## Structure

The CLI is invoked with `solid`. The commands then cascade, where actions are grouped with other similar actions. The actions will be:

- `version`: Displays a changelog of recent Solid versions

  - `start`: Specific command for Start versions

- `docs`: List a `man`-like page for versioned docs or link out to the docs

- `primitives`: Potential integration with Solid Primitives

- `add`, `remove`: Used for adding and installing integrations/packages ie. `solid add tailwind`

- `config`: For enabling a certain features ie. `solid config vite _____`

- `start`: Special keyword for SolidStart commands

  - `mode`: Changes the Start serving mode (ssr/csr/ssg) `solid mode ssr`

  - `route`: Creates a new route ie. `solid start route login`

- `new`: Opens your browser to a new template via CSB/SB ie. `solid new bare --stackblitz` opens 

- `ecosystem`

  - `add`: Starts the process of submitting your current project to our ecosystem listing (Solidex) ie. `solid ecosystem publish`

  - `search`: Initializes an ecosystem search result `solid ecosystem search auth`

## Contributing

Please feel free to contribute to this repo by creating an issue or a PR.