https://github.com/typescript-web-framework/twf-cli

TypeScript Web Framework CLI
https://github.com/typescript-web-framework/twf-cli

api apirest apirestfull cli commandline-interface framework rest restapi web web-app web-application web-development web-framework

Last synced: 4 months ago
JSON representation

TypeScript Web Framework CLI

• Host: GitHub
• URL: https://github.com/typescript-web-framework/twf-cli
• Owner: TypeScript-Web-Framework
• License: mit
• Created: 2018-07-18T14:09:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-07-19T10:54:50.000Z (5 months ago)
• Last Synced: 2025-08-22T06:23:11.379Z (4 months ago)
• Topics: api, apirest, apirestfull, cli, commandline-interface, framework, rest, restapi, web, web-app, web-application, web-development, web-framework
• Language: TypeScript
• Size: 471 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![dependencies Status](https://david-dm.org/typescript-web-framework/twf-cli/status.svg)](https://david-dm.org/typescript-web-framework/twf-cli)

[![Known Vulnerabilities](https://snyk.io/test/github/TypeScript-Web-Framework/twf-cli/badge.svg?targetFile=package.json)](https://snyk.io/test/github/TypeScript-Web-Framework/twf-cli?targetFile=package.json)

[![Maintainability](https://api.codeclimate.com/v1/badges/c0cd1d278bfb43dea2d9/maintainability)](https://codeclimate.com/github/TypeScript-Web-Framework/twf-cli/maintainability)

[![Documentation Status](https://readthedocs.org/projects/twf-cli/badge/?version=latest)](https://twf-cli.readthedocs.io/en/latest/?badge=latest)

[![Build Status](https://travis-ci.org/typescript-web-framework/twf-cli.svg?branch=master)](https://travis-ci.org/typescript-web-framework/twf-cli)

[![npm version](https://badge.fury.io/js/twf-cli.svg)](https://badge.fury.io/js/twf-cli) [![Greenkeeper badge](https://badges.greenkeeper.io/TypeScript-Web-Framework/twf-cli.svg)](https://greenkeeper.io/)

# TypeScript Web Framework Command Line Interface

TypeScript Web Framework CLI

## Features

* [x] Create project

    * [x] Current Directory

    * [x] Own Directory

* [x] Generate API Controller

    * [x] Default CRUD

        * [x] @HttpPost `create()`

        * [x] @HttpGet `read()`

        * [x] @HttpPut `update()`

        * [x] @HttpDelete `delete()`

* [x] Remove API Controller

* [x] Verify project structure

    * [x] Verify existing `www`

    * [x] Verify existing `package.json`

    * [x] Verify existing `src`

    * [x] Verify existing `src/manifiest.json`

    * [x] Verify existing `src/controllers`

    * [x] Verify existing `src/annotations`

    * [x] Verify existing `src/core`

    * [x] Verify existing `src/app.ts`

    * [x] Verify existing `src/server.ts`

    * [x] Verify existing `src/typings.d.ts`

* [x] Version info & comparison

    * [x] CLI Version

    * [x] Project Version

    * [x] Node Version

    * [x] NPM Version

* [x] Clean project

    * [x] Remove `www`

    * [x] Remove `dist`

    * [x] Remove `temp`

    * [x] Remove `node_modules`

    * [x] Remove `package-lock.json`

* [x] Install dependencies

* [x] Serve project

* [ ] Generate http property on controller

* [ ] Remove http property on controller

* [x] Test Project(Unit Testing)

* [x] Build Project

* [x] Generate compiled binary package

    * [x] Windows

    * [x] Linux

    * [x] OSX

## Commands

### Start Project

To start a new project on current directory you don't need set project name

> **!IMPORTANT**

>

> twf-cli does not interpret `.` or `..`.

```bash

twf start

```

To start a new project on with a own directory you need set project name

```bash

twf start MyProject

```

### Clean Project

```bash

twf clean

```

### Install Dependencies

```bash

twf install

```

### Verify Project 

```bash

twf verify

```

### Serve

```bash

twf serve

```

### Generate Controller

```bash

# twf add controller [name] [default route]

twf add controller index

twf add controller index /profile/:id

twf add controller main/index /profile/:id

```