Skip to content

Commit

Permalink
readme: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tommypop2 committed Jan 23, 2025
1 parent eb21580 commit de47702
Showing 1 changed file with 5 additions and 47 deletions.
52 changes: 5 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,56 +10,14 @@
[![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.
A CLI for creating and managing SolidJS apps and projects.

## Roadmap/Features
## Commands

- [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`
- `sd create`: See [create-solid](./packages/create-solid)
- `sd docs`: Opens the Solid docs in the browser
- `sd start`: Special keyword for SolidStart commands
- `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 <https://solid.new/bare>
- `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

Expand Down

0 comments on commit de47702

Please sign in to comment.