@pikku/cli 0.12.90 → 0.12.92

package/LICENSE

@@ -0,0 +1,106 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             Yasser Fadl and Pikku contributors
+Licensed Work:        Pikku CLI — code generation, dev server, migrations and deployment (@pikku/cli)
+                      Pikku Console (@pikku/console)
+                      The Licensed Work is (c) 2021 - present Yasser Fadl and Pikku contributors
+Additional Use Grant: You may make production use of the Licensed Work for any purpose,
+                      including creating free or open source software. However, you may
+                      not offer as a commercial product or service any software featuring
+                      a visual or graphical interface for authoring, editing, building,
+                      or managing Pikku code, Pikku functions, Pikku handlers, or Pikku
+                      workflows.
+Change Date:          Four years from the date the Licensed Work was first made available
+Change License:       MIT License
+
+For information about alternative licensing arrangements, contact yasser.fadl@gmail.com
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open Source
+license. However, the Licensed Work will eventually be made available under an Open
+Source License, as stated in this License.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works,
+redistribute, and make non-production use of the Licensed Work. The Licensor may make
+an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this License,
+whichever comes first, the Licensor hereby grants you rights under the terms of the
+Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in
+effect as described in this License, you must purchase a commercial license from the
+Licensor, its affiliated entities, or authorized resellers, or you must refrain from
+using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the
+Licensed Work, are subject to this License. This License applies separately for each
+version of the Licensed Work and the Change Date may vary for each version of the
+Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the
+Licensed Work. If you receive the Licensed Work in original or modified form from a
+third party, the terms and conditions set forth in this License apply to your use of
+that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate
+your rights under this License for the current and all other versions of the Licensed
+Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its
+affiliates (provided that you may use a trademark or logo of Licensor as expressly
+required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS"
+BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED,
+INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE, NON-INFRINGEMENT, AND TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license your works,
+and to refer to it using the trademark "Business Source License", as long as you
+comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License's text and the "Business Source
+License" name and trademark, Licensor covenants to MariaDB, and to all other
+recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version, or a
+   license that is compatible with GPL Version 2.0 or a later version, where
+   "compatible" means that software provided under the Change License can be included
+   in a program with software provided under GPL Version 2.0 or a later version.
+   Licensor may specify additional Change Licenses without limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not impose
+   any additional restriction on the right granted in this License, as the Additional
+   Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Note: Every other Pikku package — @pikku/core, the runtimes, the services, the clients,
+and @pikku/skills — is licensed under the MIT License. Each package ships its own LICENSE
+file stating its terms; that file governs, and this one covers only the Licensed Work
+named above.
+
+In particular, the Pikku agent skills (@pikku/skills) are MIT. They are the instruction
+set coding agents read to build, wire and deploy Pikku projects, and they are meant to be
+adopted, forked and extended by any harness — so their terms do not depend on the CLI
+that happens to install them.

package/README.md

@@ -1,3 +1,26 @@
-# Pikku CLI
+# @pikku/cli
 
-This package is part of @pikku/mono and is responsible for all the intropsection and file generations.
+The Pikku CLI. Inspects your TypeScript source and generates bootstrap files,
+typed clients, OpenAPI specs and deployment artifacts.
+
+## Install
+
+```bash
+npm install -D @pikku/cli
+```
+
+## Usage
+
+```bash
+npx pikku          # generate everything from pikku.config.json
+npx pikku dev      # generate, then run a dev server with hot reload
+npx pikku db migrate
+npx pikku deploy
+```
+
+Configuration lives in `pikku.config.json` — `srcDirectories`, `outDir` and the
+client files to emit.
+
+## Docs
+
+https://pikku.dev/docs